ci(yarn): turning this into an npm package?

Author: dk949

package.json

@@ -2,22 +2,37 @@
   "name": "JC-ProjectExportAPI",
   "version": "0.0.1",
   "description": "Project export API",
-  "main": "dist/test.js",
+  "main": "dist/index.js",
   "author": "dk949",
   "license": "MIT",
-  "private": true,
+  "private": false,
   "scripts": {
     "cp": "node .github/cp.js",
     "mkdir": "node .github/mkdir.js",
-    "build": "yarn run tsc",
-    "release": "yarn build && yarn cp ./src/ProjectExport.d.ts dist",
+    "build": "yarn tsc",
+    "release": "yarn build && yarn cp ./src/project.d.ts dist && yarn cp ./src/index.d.ts dist",
     "test": "mocha"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JumpCutter/JC-ProjectExportAPI"
+  },
+  "keywords": [
+    "JumpCutter",
+    "Editor"
+  ],
+  "bugs": {
+    "url": "https://github.com/JumpCutter/JC-ProjectExportAPI/issues"
+  },
+  "homepage": "https://github.com/JumpCutter/JC-ProjectExportAPI#readme",
+  "files": [
+    "dist/**/*"
+  ],
   "dependencies": {
-    "edl_composer": "^1.0.3",
-    "typescript": "^4.4.3"
+    "edl_composer": "^1.0.3"
   },
   "devDependencies": {
+    "typescript": "^4.3.4",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.10.2",
     "mocha": "^9.1.2",

src/index.d.ts

@@ -0,0 +1,11 @@
+import * as Project from "./project";
+export {Project};
+export abstract class Generator{
+    constructor(project: Project.Project)
+    generate(): string;
+}
+
+export class ResolveEDL extends Generator{}
+export class VegasEDL extends Generator{}
+export class FCPXML extends Generator{}
+export class XML extends Generator{}

src/ProjectExport.d.ts src/index.tssrc/ProjectExport.d.ts renamed to src/index.ts

@@ -1,6 +1,6 @@
 export interface Project {
     outFile: string;
-    resolution?: null;
+    resolution: string | null;
     frameRate: number;
     layers?: Layers | null;
 }

src/project.d.ts

@@ -1,13 +1,8 @@
-import {VegasEDL} from "../src/vegasEDL/genVegasEDL"
-import {ResolveEDL} from "../src/EDL/genEDL"
-import {FCPXML} from "../src/FCPXML/genFCPXML"
-import {XML} from "../src/XML/genXML"
-
+import * as PEAPI from "../src/index";
 import fs from "fs";
 import path from "path";
 
 
-
 let generators = {};
 
 
@@ -18,7 +13,7 @@ project["layers"][0][0]["sourceFile"] = "../JC-examples/yoga.mp4"
 describe("generating vegasEDL for importing into Sony Vegas Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["VegasEDL"] = (new VegasEDL(tmp));
+        generators["VegasEDL"] = (new PEAPI.VegasEDL(tmp));
     });
     it("generate a string representing a project in the EDL format Sony vegas supports", () => {
         fs.writeFileSync(path.join(__dirname, "./test.txt"), generators["VegasEDL"].generate());
@@ -28,7 +23,7 @@ describe("generating vegasEDL for importing into Sony Vegas Pro", () => {
 describe("generating EDL for importing into DaVinci Resolve", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["ResolveEDL"] = (new ResolveEDL(tmp));
+        generators["ResolveEDL"] = (new PEAPI.ResolveEDL(tmp));
     });
     it("generate a string representing a project in the EDL format", () => {
         fs.writeFileSync(path.join(__dirname, "./test.edl"), generators["ResolveEDL"].generate());
@@ -39,7 +34,7 @@ describe("generating EDL for importing into DaVinci Resolve", () => {
 describe("generating FCPXML for importing into FinalCut Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["FCPXML"] = (new FCPXML(tmp));
+        generators["FCPXML"] = (new PEAPI.FCPXML(tmp));
     });
     it("generate a string representing a project in the FCPXML format", () => {
         fs.writeFileSync(path.join(__dirname, "./test.fcpxml"), generators["FCPXML"].generate());
@@ -51,7 +46,7 @@ describe("generating FCPXML for importing into FinalCut Pro", () => {
 describe("generating XML for importing into Premiere Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["XML"] = (new XML(tmp));
+        generators["XML"] = (new PEAPI.XML(tmp));
     });
     it("generate a string representing a project in the EDL format Sony vegas supports", () => {
         fs.writeFileSync(path.join(__dirname, "./test.xml"), generators["XML"].generate());

test/index.spec.ts

@@ -40,9 +40,9 @@
   integrity sha512-scN0hAWyLVAvLR9AyW7HoFF5sJZglyBsbPuHO4fv7JRvfmPBMfp1ozWqOf/e4wwPNxezBZXRfWzMb6iFLgEVRA==
 
 "@types/node@^16.10.2":
-  version "16.10.2"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.10.2.tgz#5764ca9aa94470adb4e1185fe2e9f19458992b2e"
-  integrity sha512-zCclL4/rx+W5SQTzFs9wyvvyCwoK9QtBpratqz2IYJ3O8Umrn0m3nsTv0wQBk9sRGpvUe9CwPDrQFB10f1FIjQ==
+  version "16.10.3"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.10.3.tgz#7a8f2838603ea314d1d22bb3171d899e15c57bd5"
+  integrity sha512-ho3Ruq+fFnBrZhUYI46n/bV2GjwzSkwuT4dTf0GkuNFmnb8nq4ny2z9JEVemFi6bdEJanHLlYfy9c6FN9B9McQ==
 
 "@ungap/promise-all-settled@1.1.2":
   version "1.1.2"
@@ -569,7 +569,7 @@ ts-node@^10.2.1:
     make-error "^1.1.1"
     yn "3.1.1"
 
-typescript@^4.4.3:
+typescript@^4.3.4:
   version "4.4.3"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324"
   integrity sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA==