castle-web-sdk 0.4.10 → 0.4.11

package/dist/castle.d.ts

@@ -1,5 +1,6 @@
 export { isEdit } from "./context";
 export { CastleError } from "./errors";
+export { deckPrefixOf, IMPORTS_DIR, IMPORTS_PREFIX, isImportedFile, resolveDeckFile, } from "./files";
 export { Haptics } from "./haptics";
 export type { CastleHapticsApi, HapticsResult, HapticsStatus, HapticStyle } from "./haptics";
 export { Leaderboard } from "./leaderboard";

package/dist/castle.js

@@ -1,6 +1,7 @@
 // Castle Web SDK
 export { isEdit } from "./context";
 export { CastleError } from "./errors";
+export { deckPrefixOf, IMPORTS_DIR, IMPORTS_PREFIX, isImportedFile, resolveDeckFile, } from "./files";
 export { Haptics } from "./haptics";
 export { Leaderboard } from "./leaderboard";
 export { Lifecycle } from "./lifecycle";

package/dist/files.d.ts

@@ -0,0 +1,15 @@
+export declare const IMPORTS_PREFIX = "@imports/";
+export declare const IMPORTS_DIR = "imports";
+export declare function deckPrefixOf(filePath: string): string;
+/**
+ * Resolve a reference to the key it names in the deck's file map.
+ *
+ * @param ref  the reference as written -- `drawings/rock.pxart` or
+ *             `@imports/someone.pack/drawings/rock.pxart`
+ * @param from the path of the file the reference was written in; a reference in
+ *             a deck's own file resolves against the deck root, one in an
+ *             import's file against that import.
+ */
+export declare function resolveDeckFile(ref: string, from?: string): string;
+/** Whether a path names a file some import owns (rather than the deck's own). */
+export declare function isImportedFile(filePath: string): boolean;

package/dist/files.js

@@ -0,0 +1,52 @@
+// How a deck names a file -- one rule, everywhere a path appears: in JS module
+// specifiers, in a scene's `blueprint`, in a Sprite's `file`, in anything a kit
+// invents later.
+//
+//   drawings/rock.pxart          a file of the deck the REFERENCE lives in
+//   @imports/<alias>/drawings/rock.pxart   a file of that import
+//
+// The unprefixed form is deck-relative, and "the deck" means whichever deck the
+// referencing file belongs to. So a kit's blueprint saying `drawings/cauldron.pxart`
+// means the kit's own drawing whether the kit is the deck being played or an
+// import of it -- the same text keeps meaning the same file after the kit is
+// imported by somebody else. That is what makes a deck publishable as a
+// dependency without rewriting its insides.
+//
+// `@imports/` is the only way to name someone else's file, so a cross-deck
+// reference is visible as one at a glance, and it means the same thing from any
+// depth: imports are flattened into one `imports/` at the deck root, so the
+// prefix is positional in nothing.
+export const IMPORTS_PREFIX = '@imports/';
+// Where imports live on disk, relative to the deck root. `@imports/x/y` is
+// exactly `imports/x/y` -- the alias exists so the reference reads as a
+// cross-deck one and does not depend on where the referencing file sits.
+export const IMPORTS_DIR = 'imports';
+function stripDotSlash(path) {
+    return path.replace(/^\.\//, '');
+}
+// The deck a file belongs to, as a path prefix: `imports/<alias>/` for a file of
+// an import, `''` for one of the deck's own.
+export function deckPrefixOf(filePath) {
+    const match = new RegExp(`^(${IMPORTS_DIR}/[^/]+/)`).exec(filePath ?? '');
+    return match ? match[1] : '';
+}
+/**
+ * Resolve a reference to the key it names in the deck's file map.
+ *
+ * @param ref  the reference as written -- `drawings/rock.pxart` or
+ *             `@imports/someone.pack/drawings/rock.pxart`
+ * @param from the path of the file the reference was written in; a reference in
+ *             a deck's own file resolves against the deck root, one in an
+ *             import's file against that import.
+ */
+export function resolveDeckFile(ref, from = '') {
+    const path = stripDotSlash(String(ref ?? ''));
+    if (path.startsWith(IMPORTS_PREFIX)) {
+        return `${IMPORTS_DIR}/${path.slice(IMPORTS_PREFIX.length)}`;
+    }
+    return deckPrefixOf(stripDotSlash(from)) + path;
+}
+/** Whether a path names a file some import owns (rather than the deck's own). */
+export function isImportedFile(filePath) {
+    return deckPrefixOf(filePath) !== '';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "castle-web-sdk",
-  "version": "0.4.10",
+  "version": "0.4.11",
   "type": "module",
   "main": "dist/castle.js",
   "types": "dist/castle.d.ts",