@evitcastudio/kit 1.3.1 → 1.4.0

package/README.md

@@ -14,6 +14,31 @@ npm i @evitcastudio/kit -g
 
 *global flag is so the path is set properly for the CLI tool*
 
+# Resources
+
+This script will locate all Vylocity engine-related files within the specified directory and anonymize them before placing them in the designated resources folder.
+
+```bash
+# From the CLI you will build all your resources to the out dir
+kit build -i ./<in-dir> -o ./<out-dir>
+```
+
+During the execution of this command, a `resource.json` file will be automatically generated within your source directory.
+It is recommended to exclude this file from your version control system, as it is considered a build artifact.
+
+
+> [!IMPORTANT]
+> This API should be ran BEFORE VYLO.load() is called.
+
+> [!WARNING]
+> Depending on your environment the following [import syntax](https://github.com/EvitcaStudio/Kit/wiki/FAQ#importing-json-resources) for json may not work.
+
+
+```js
+import resourceJSON from 'resource.json';
+await Kit.setResources(resourceJSON);
+```
+
 # Using Kit with plugins
 
 ```ts

package/lib/bundle/cli/cli.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 /*!
- * @evitcastudio/kit@1.3.1 git+https://github.com/EvitcaStudio/Kit.git
- * Compiled Sat, 04 Jan 2025 15:50:23 UTC
+ * @evitcastudio/kit@1.4.0 git+https://github.com/EvitcaStudio/Kit.git
+ * Compiled Sat, 04 Jan 2025 17:47:08 UTC
  * Copyright (c) 2025 Jared Bates, Evitca Studio, "doubleactii"
  *
  * @evitcastudio/kit is licensed under the MIT License.
@@ -2437,8 +2437,8 @@ function initializeResourceJSON() {
 }
 function prepareFileForProcessing(filePath) {
   const extension = extname(filePath).slice(1);
-  const fileName = filePath.replace(/^.*[\\\/]/, "");
-  const resourceIdentifier = `${v4_default()}.${extension}`;
+  const fileName = basename(filePath);
+  const resourceIdentifier = `${v4_default()}.vyr`;
   const type = getResourceType(extension);
   if (!type)
     return;
@@ -2499,7 +2499,8 @@ async function processAllFiles() {
         throw new Error(`Resource not found for file: ${fileName}`);
       }
       const destination = join(resourceOutDirectory, "resources");
-      return copyFile(filePath, destination, resource.resourceIdentifier);
+      const resourceName = resource.resourceIdentifier;
+      return copyFile(filePath, destination, resourceName);
     });
     await Promise.all(copyOperations);
     logVerbose(`[Kit CLI] All resources have been processed.`);
@@ -2527,9 +2528,9 @@ async function copyFile(pSource, pDestinationDir, pNewName) {
   }
 }
 async function saveResourceJSON() {
-  const filePath = join(resourceOutDirectory, "resources", "resource.json");
+  const filePath = "resource.json";
   try {
-    await fs.writeFile(filePath, JSON.stringify(resourceJSON, null, 2));
+    await fs.writeFile(filePath, JSON.stringify(resourceJSON, null, 4));
   } catch (pError) {
     logError(`[Error] Saving resource JSON: ${pError}`);
   }
@@ -2572,7 +2573,7 @@ class KitCLI {
 // package.json
 var package_default = {
   name: "@evitcastudio/kit",
-  version: "1.3.1",
+  version: "1.4.0",
   author: "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   main: "./lib/index.js",
   types: "./lib/index.d.ts",

package/lib/kit.d.ts

@@ -1,5 +1,5 @@
 import type { KitPlugin } from '@evitcastudio/kit-plugin';
-import type { EmitterEvent, Listener, KitPluginConstructor } from './types/shared-types';
+import type { EmitterEvent, ResourceData, Listener, KitPluginConstructor } from './types/shared-types';
 export declare class Kit {
     /**
      * A record of all plugins registered with the Kit class.
@@ -60,6 +60,6 @@ export declare class Kit {
     /**
      * Sets the resources found in resources and preloads all interfaces found.
      */
-    static setResources(): Promise<void>;
+    static setResources(pResourceJson: Record<string, ResourceData[]>): Promise<void>;
 }
 //# sourceMappingURL=kit.d.ts.map

package/lib/kit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAgB,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAevG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI;IAkBlF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAInE;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE;IAI7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAWlB;;;;;MAKE;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAQ7E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAOnG;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CA4C7C"}
+{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAevG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI;IAkBlF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAInE;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE;IAI7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAWlB;;;;;MAKE;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAQ7E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAOnG;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAa1F"}

package/lib/kit.js

@@ -124,39 +124,12 @@ export class Kit {
     /**
      * Sets the resources found in resources and preloads all interfaces found.
      */
-    static async setResources() {
+    static async setResources(pResourceJson) {
         if (!globalThis.VYLO) {
             throw new Error('[Kit] VYLO is not defined. Please ensure the VYLO variable is available in the global namespace.');
         }
-        let resourcePath = './resources/resource.json';
-        let resourceJson;
-        // Server environment (we do not use fetch as the file:// protocol is not supported atm)
-        if (!globalThis.window) {
-            const [fsPromises, path] = await Promise.all([
-                import('fs/promises'),
-                import('path')
-            ]);
-            const { readFile } = fsPromises;
-            resourcePath = path.resolve('resources', 'resource.json');
-            const data = await readFile(resourcePath, 'utf-8');
-            resourceJson = JSON.parse(data);
-            // Client environment
-        }
-        else {
-            // Load the resource json and set the resources found
-            try {
-                const response = await fetch(resourcePath);
-                if (!response.ok) {
-                    throw new Error(`[Kit] HTTP error! Status: ${response.status}`);
-                }
-                resourceJson = await response.json();
-            }
-            catch (pError) {
-                console.error(`[Kit] error reading ${resourcePath}`, pError);
-            }
-        }
-        if (resourceJson) {
-            const resources = Object.values(resourceJson);
+        if (pResourceJson) {
+            const resources = Object.values(pResourceJson);
             // Group all data from separate arrays in object to one unified array of all resource data
             const consolidatedData = resources.flat();
             // Set all the resources

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evitcastudio/kit",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",