@patterkit/model 0.1.0

package/dist/index.js

@@ -0,0 +1,83 @@
+// src/index.ts
+function walkNodes(nodes, visit) {
+  for (const node of nodes) {
+    visit(node);
+    const children = node.children;
+    if (children) walkNodes(children, visit);
+  }
+}
+function isContentlessBeat(beat, hasText) {
+  if (beat.kind === "gameEvent") return false;
+  if (hasText) return false;
+  if (beat.gameData && Object.keys(beat.gameData).length > 0) return false;
+  if (beat.tags && beat.tags.length > 0) return false;
+  return beat.kind === "text" || !beat.character && !beat.direction;
+}
+function gameIdify(text) {
+  return text.toLowerCase().replace(/['’]/g, "").replace(/[^a-z0-9-]+/g, "-").replace(/-+/g, "-").replace(/^-+|-+$/g, "");
+}
+function isValidGameId(gameId) {
+  return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(gameId);
+}
+function effectiveGameId(entity) {
+  const g = entity.gameId?.trim();
+  return g ? g : gameIdify(entity.name);
+}
+var DEFAULT_WRITING_STATUSES = [
+  { name: "stub", colour: 0 },
+  // red
+  { name: "draft 1", colour: 1 },
+  // rust
+  { name: "draft 2", colour: 2 },
+  // ochre
+  { name: "edited", readyToRecord: true, colour: 4 },
+  // green
+  { name: "final", readyToShip: true, colour: 9 }
+  // purple (violet)
+];
+var DEFAULT_RECORDING_STATUSES = [
+  { name: "missing", colour: 0 },
+  // red
+  { name: "scratch", colour: 2 },
+  // ochre
+  { name: "recorded", colour: 4 },
+  // green
+  { name: "final", colour: 9 }
+  // purple
+];
+function deriveRecordingFolders(audioRoot, statuses) {
+  const root = audioRoot?.trim();
+  return statuses.map((s, i) => {
+    if (i === 0 || !root) return { name: s.name };
+    return { name: s.name, folder: `${root}/${gameIdify(s.name)}` };
+  });
+}
+var DEFAULT_DOCUMENTATION_CLASSES = [
+  { name: "everyone", deliver: "*" },
+  // every export, and (like all) the editor
+  { name: "vo", deliver: ["vo"] },
+  // voice-recording scripts
+  { name: "loc", deliver: ["loc"] }
+  // localisation handoff
+];
+var PROJECT_LOCALE_SCENE = "@project";
+function castStringKey(name) {
+  return `cast:${name}`;
+}
+var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
+var DEFAULT_CAPTION_CHARACTER = "SFX";
+export {
+  DEFAULT_CAPTION_CHARACTER,
+  DEFAULT_CAPTION_DELIMITERS,
+  DEFAULT_DOCUMENTATION_CLASSES,
+  DEFAULT_RECORDING_STATUSES,
+  DEFAULT_WRITING_STATUSES,
+  PROJECT_LOCALE_SCENE,
+  castStringKey,
+  deriveRecordingFolders,
+  effectiveGameId,
+  gameIdify,
+  isContentlessBeat,
+  isValidGameId,
+  walkNodes
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@patterkit/model",
+  "version": "0.1.0",
+  "description": "Patter data-model types: source (scene/block/group/snippet/beat/jump), project, locale, authoring. The shape source-of-truth.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Ian Thomas",
+  "homepage": "https://patterkit.dev",
+  "repository": { "type": "git", "url": "git+https://github.com/patterkit/patter.git", "directory": "packages/model" },
+  "bugs": "https://github.com/patterkit/patter/issues",
+  "publishConfig": { "access": "public" },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": ["dist", "README.md"],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean"
+  },
+  "dependencies": {
+    "@wildwinter/expr": "^0.3.0"
+  }
+}