@b2bc-devkit/sheetorm 1.2.0 → 1.2.3

package/package.json

@@ -1,86 +1,171 @@
-{
-  "name": "@b2bc-devkit/sheetorm",
-  "version": "1.2.0",
-  "description": "TypeScript ORM for Google Sheets (Google Apps Script runtime)",
-  "type": "module",
-  "license": "GPL-3.0-or-later",
-  "scripts": {
-    "build": "node scripts/build.mjs",
-    "build:npm": "node scripts/build-npm.mjs",
-    "lint": "eslint .",
-    "format": "prettier . --write",
-    "test": "jest --verbose",
-    "login": "clasp login"
-  },
-  "files": [
-    "dist/npm/**/*"
-  ],
-  "main": "./dist/npm/SheetOrm.js",
-  "module": "./dist/npm/SheetOrm.js",
-  "types": "./dist/npm/SheetOrm.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/npm/SheetOrm.js",
-      "types": "./dist/npm/SheetOrm.d.ts"
-    },
-    "./SheetOrm": {
-      "import": "./dist/npm/SheetOrm.js",
-      "types": "./dist/npm/SheetOrm.d.ts"
-    },
-    "./core/Record": {
-      "import": "./dist/npm/core/Record.js",
-      "types": "./dist/npm/core/Record.d.ts"
-    },
-    "./core/Decorators": {
-      "import": "./dist/npm/core/Decorators.js",
-      "types": "./dist/npm/core/Decorators.d.ts"
-    },
-    "./query/Query": {
-      "import": "./dist/npm/query/Query.js",
-      "types": "./dist/npm/query/Query.d.ts"
-    },
-    "./index/IndexStore": {
-      "import": "./dist/npm/index/IndexStore.js",
-      "types": "./dist/npm/index/IndexStore.d.ts"
-    },
-    "./core/Registry": {
-      "import": "./dist/npm/core/Registry.js",
-      "types": "./dist/npm/core/Registry.d.ts"
-    },
-    "./package.json": "./package.json"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/b2bc-devkit/SheetORM.git"
-  },
-  "homepage": "https://github.com/b2bc-devkit/SheetORM#readme",
-  "bugs": {
-    "url": "https://github.com/b2bc-devkit/SheetORM/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@b2bc-devkit/gas-class-entrypoints": "^1.0.0",
-    "@babel/core": "^7.29.0",
-    "@babel/plugin-transform-class-properties": "^7.28.6",
-    "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6",
-    "@babel/plugin-transform-numeric-separator": "^7.28.6",
-    "@babel/plugin-transform-optional-chaining": "^7.28.6",
-    "@google/clasp": "^3.3.0",
-    "@rollup/plugin-babel": "^7.0.0",
-    "@types/google-apps-script": "^2.0.8",
-    "@types/jest": "^30.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.57.1",
-    "@typescript-eslint/parser": "^8.57.1",
-    "eslint": "^10.0.3",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-googleappsscript": "^1.0.5",
-    "jest": "^30.3.0",
-    "prettier": "^3.8.1",
-    "terser": "^5.44.1",
-    "ts-jest": "^29.4.6",
-    "typescript": "^6.0.2",
-    "vite": "^8.0.8"
-  }
-}
+{
+  "name": "@b2bc-devkit/sheetorm",
+  "version": "1.2.3",
+  "description": "TypeScript ORM for Google Sheets (Google Apps Script runtime)",
+  "type": "module",
+  "license": "GPL-3.0-or-later",
+  "scripts": {
+    "build": "wireit",
+    "build:npm": "wireit",
+    "lint": "wireit",
+    "knip": "wireit",
+    "trivy:scan": "wireit",
+    "format": "prettier . --write",
+    "test": "wireit",
+    "login": "clasp login"
+  },
+  "wireit": {
+    "knip": {
+      "command": "knip",
+      "files": [
+        "src/**/*.ts",
+        "tests/**/*.ts",
+        "examples/**/*.ts",
+        "scripts/**/*.mjs",
+        "knip.json",
+        "package.json",
+        "tsconfig.json",
+        "tsconfig.gas.json",
+        "tsconfig.npm.json",
+        "tsconfig.test.json",
+        "vite.config.mjs",
+        "eslint.config.cjs",
+        "jest.config.cjs"
+      ],
+      "output": []
+    },
+    "trivy:scan": {
+      "command": "npx @b2bc-devkit/trivy-scan fs --config trivy.yaml .",
+      "files": [
+        "package-lock.json",
+        "trivy.yaml"
+      ],
+      "output": []
+    },
+    "build": {
+      "command": "node scripts/build.mjs",
+      "dependencies": [
+        "knip",
+        "trivy:scan"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "scripts/build.mjs",
+        "tsconfig.json",
+        "tsconfig.gas.json",
+        "vite.config.mjs",
+        "appsscript.json"
+      ],
+      "output": [
+        "build/**",
+        "Code.js"
+      ]
+    },
+    "build:npm": {
+      "command": "node scripts/build-npm.mjs",
+      "dependencies": [
+        "knip",
+        "trivy:scan"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "scripts/build-npm.mjs",
+        "tsconfig.json",
+        "tsconfig.npm.json"
+      ],
+      "output": [
+        "dist/npm/**"
+      ]
+    },
+    "lint": {
+      "command": "eslint .",
+      "files": [
+        "src/**/*.ts",
+        "tests/**/*.ts",
+        "examples/**/*.ts",
+        "scripts/**/*.mjs",
+        "eslint.config.cjs",
+        "package.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "command": "jest --verbose",
+      "files": [
+        "src/**/*.ts",
+        "tests/**/*.ts",
+        "jest.config.cjs",
+        "tsconfig.test.json",
+        "package.json"
+      ],
+      "output": []
+    }
+  },
+  "files": [
+    "dist/npm/**/*"
+  ],
+  "main": "./dist/npm/SheetOrm.js",
+  "module": "./dist/npm/SheetOrm.js",
+  "types": "./dist/npm/SheetOrm.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/npm/SheetOrm.js",
+      "types": "./dist/npm/SheetOrm.d.ts"
+    },
+    "./SheetOrm": {
+      "import": "./dist/npm/SheetOrm.js",
+      "types": "./dist/npm/SheetOrm.d.ts"
+    },
+    "./core/Record": {
+      "import": "./dist/npm/core/Record.js",
+      "types": "./dist/npm/core/Record.d.ts"
+    },
+    "./core/Decorators": {
+      "import": "./dist/npm/core/Decorators.js",
+      "types": "./dist/npm/core/Decorators.d.ts"
+    },
+    "./query/Query": {
+      "import": "./dist/npm/query/Query.js",
+      "types": "./dist/npm/query/Query.d.ts"
+    },
+    "./index/IndexStore": {
+      "import": "./dist/npm/index/IndexStore.js",
+      "types": "./dist/npm/index/IndexStore.d.ts"
+    },
+    "./core/Registry": {
+      "import": "./dist/npm/core/Registry.js",
+      "types": "./dist/npm/core/Registry.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/b2bc-devkit/SheetORM.git"
+  },
+  "homepage": "https://github.com/b2bc-devkit/SheetORM#readme",
+  "bugs": {
+    "url": "https://github.com/b2bc-devkit/SheetORM/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@b2bc-devkit/gas-class-entrypoints": "^1.0.0",
+    "@google/clasp": "^3.3.0",
+    "@types/google-apps-script": "^2.0.8",
+    "@types/jest": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.57.1",
+    "@typescript-eslint/parser": "^8.57.1",
+    "eslint": "^10.0.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-googleappsscript": "^1.0.5",
+    "jest": "^30.3.0",
+    "knip": "^6.25.0",
+    "prettier": "^3.8.1",
+    "terser": "^5.44.1",
+    "ts-jest": "^29.4.6",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.8",
+    "wireit": "^0.14.13"
+  }
+}

package/dist/npm/SheetOrm.d.ts

@@ -1,41 +0,0 @@
-/**
- * @module SheetOrm
- *
- * NPM package entry point for the SheetORM library.
- *
- * Re-exports the core public API surface as static members of a single
- * namespace class.  Consumer code imports from this module:
- *
- * ```ts
- * import { SheetOrm } from "sheetorm";
- * const { Record, Query, Decorators, IndexStore, Registry } = SheetOrm;
- * ```
- *
- * This file is referenced by `tsconfig.npm.json` and the npm build
- * script; it does **not** include GAS-specific helpers (e.g. demos,
- * test runners) that live in `index.ts`.
- */
-import { Decorators } from "./core/Decorators.js";
-import { Record } from "./core/Record.js";
-import { Registry } from "./core/Registry.js";
-import { IndexStore } from "./index/IndexStore.js";
-import { Query } from "./query/Query.js";
-/**
- * Top-level namespace class that bundles every public SheetORM artifact.
- *
- * Designed as a single default import so consumers can destructure
- * only the parts they need without deep import paths.
- */
-export declare class SheetOrm {
-    /** ActiveRecord base class — extend this to define entity models. */
-    static readonly Record: typeof Record;
-    /** Fluent query builder for filtering, sorting, and paginating records. */
-    static readonly Query: typeof Query;
-    /** Property decorators: `@Field`, `@Indexed`, `@Required`. */
-    static readonly Decorators: typeof Decorators;
-    /** Secondary-index manager with n-gram text search. */
-    static readonly IndexStore: typeof IndexStore;
-    /** Singleton registry that tracks all registered entity classes. */
-    static readonly Registry: typeof Registry;
-}
-//# sourceMappingURL=SheetOrm.d.ts.map

package/dist/npm/SheetOrm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SheetOrm.d.ts","sourceRoot":"","sources":["../../src/SheetOrm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB,qEAAqE;IACrE,MAAM,CAAC,QAAQ,CAAC,MAAM,gBAAU;IAChC,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,CAAC,KAAK,eAAS;IAC9B,8DAA8D;IAC9D,MAAM,CAAC,QAAQ,CAAC,UAAU,oBAAc;IACxC,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,UAAU,oBAAc;IACxC,oEAAoE;IACpE,MAAM,CAAC,QAAQ,CAAC,QAAQ,kBAAY;CACrC"}

package/dist/npm/SheetOrm.js

@@ -1,41 +0,0 @@
-/**
- * @module SheetOrm
- *
- * NPM package entry point for the SheetORM library.
- *
- * Re-exports the core public API surface as static members of a single
- * namespace class.  Consumer code imports from this module:
- *
- * ```ts
- * import { SheetOrm } from "sheetorm";
- * const { Record, Query, Decorators, IndexStore, Registry } = SheetOrm;
- * ```
- *
- * This file is referenced by `tsconfig.npm.json` and the npm build
- * script; it does **not** include GAS-specific helpers (e.g. demos,
- * test runners) that live in `index.ts`.
- */
-import { Decorators } from "./core/Decorators.js";
-import { Record } from "./core/Record.js";
-import { Registry } from "./core/Registry.js";
-import { IndexStore } from "./index/IndexStore.js";
-import { Query } from "./query/Query.js";
-/**
- * Top-level namespace class that bundles every public SheetORM artifact.
- *
- * Designed as a single default import so consumers can destructure
- * only the parts they need without deep import paths.
- */
-export class SheetOrm {
-}
-/** ActiveRecord base class — extend this to define entity models. */
-SheetOrm.Record = Record;
-/** Fluent query builder for filtering, sorting, and paginating records. */
-SheetOrm.Query = Query;
-/** Property decorators: `@Field`, `@Indexed`, `@Required`. */
-SheetOrm.Decorators = Decorators;
-/** Secondary-index manager with n-gram text search. */
-SheetOrm.IndexStore = IndexStore;
-/** Singleton registry that tracks all registered entity classes. */
-SheetOrm.Registry = Registry;
-//# sourceMappingURL=SheetOrm.js.map

package/dist/npm/SheetOrm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SheetOrm.js","sourceRoot":"","sources":["../../src/SheetOrm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;;AACnB,qEAAqE;AACrD,eAAM,GAAG,MAAM,CAAC;AAChC,2EAA2E;AAC3D,cAAK,GAAG,KAAK,CAAC;AAC9B,8DAA8D;AAC9C,mBAAU,GAAG,UAAU,CAAC;AACxC,uDAAuD;AACvC,mBAAU,GAAG,UAAU,CAAC;AACxC,oEAAoE;AACpD,iBAAQ,GAAG,QAAQ,CAAC"}

package/dist/npm/core/Decorators.d.ts

@@ -1,145 +0,0 @@
-/**
- * Decorator-based metadata system for declaring Record model fields and indexes.
- *
- * Provides three property decorators:
- *   - `@Indexed()` — mark a field for secondary indexing (lookups via IndexStore).
- *   - `@Required()` — shorthand for `@Field({ required: true })`.
- *   - `@Field()`   — override field metadata (type, required, defaultValue, etc.).
- *
- * And two discovery helpers:
- *   - `getFields(ctor)`  — return all FieldDefinition[] for a class.
- *   - `getIndexes(ctor)` — return all IndexDefinition[] for a class.
- *
- * Metadata is stored in module-scoped Maps keyed by constructor:
- *   - `indexedMeta`  — primary @Indexed entries.
- *   - `fieldMeta`    — primary @Field / @Required / @Indexed field patches.
- *   - `fieldsCache`  — derived FieldDefinition[] (invalidated on decoration).
- *   - `indexesCache` — derived IndexDefinition[] (invalidated on decoration).
- *
- * @module Decorators
- */
-import type { FieldDefinition } from "./types/FieldDefinition.js";
-import type { FieldType } from "./types/FieldType.js";
-import type { IndexDefinition } from "./types/IndexDefinition.js";
-/** Constructor shape accepted by the decorators (any class that produces an object). */
-interface DecoratedModelCtor {
-    new (): object;
-}
-/**
- * Mark a field as indexed for faster lookups via IndexStore.
- *
- * When a Record subclass has fields decorated with `@Indexed()`, SheetORM
- * creates a combined index sheet (e.g. `idx_Cars`) and maintains index entries
- * during save/delete operations. The `search` filter operator leverages the
- * index for n-gram full-text search.
- *
- * @param options.unique - Enforce unique values across all entities (default: false).
- * @param options.type   - Storage type hint for the index ("string" | "number" | "date").
- * @returns A standard TypeScript property decorator.
- *
- * @example
- * class Car extends Record {
- *   @Indexed({ unique: true })
- *   vin!: string;
- *
- *   @Indexed()
- *   make!: string;
- * }
- */
-declare function Indexed(options?: {
-    unique?: boolean;
-    type?: "string" | "number" | "date";
-}): PropertyDecorator;
-/**
- * Mark a field as required — shorthand for `@Field({ required: true })`.
- *
- * Required fields are validated during save(); an error is thrown if the
- * value is null, undefined, or an empty string.
- *
- * @example
- * class User extends Record {
- *   @Required()
- *   email!: string;
- * }
- */
-declare function Required(): PropertyDecorator;
-/**
- * Override field metadata: storage type, required flag, default value, or
- * reference table name.
- *
- * Fields that do not carry any decorator are still auto-discovered from a
- * temporary instance's own properties. Use `@Field()` when you need to
- * explicitly set the storage type or a default value.
- *
- * @param options.type           - Storage type ("string" | "number" | "boolean" | "date" | "json" | "reference").
- * @param options.required       - Validate non-empty on save (default: false).
- * @param options.defaultValue   - Fallback value when the field is undefined.
- * @param options.referenceTable - Related table name (for "reference" type fields).
- *
- * @example
- * class Product extends Record {
- *   @Field({ type: "number", defaultValue: 0 })
- *   price!: number;
- *
- *   @Field({ type: "json" })
- *   metadata!: Record<string, unknown>;
- * }
- */
-declare function Field(options?: {
-    type?: FieldType;
-    required?: boolean;
-    defaultValue?: unknown;
-    referenceTable?: string;
-}): PropertyDecorator;
-/**
- * Discover all user-defined fields for a Record subclass.
- *
- * Merges two sources:
- *   1. **Own properties** from a temporary instance — captures ESNext [[Define]]
- *      class fields that become own properties without a decorator.
- *   2. **Decorator metadata** from `@Indexed` / `@Field` / `@Required` — captures
- *      fields declared with [[Set]] semantics (TypeScript `useDefineForClassFields: false`).
- *
- * Results are cached per constructor and invalidated whenever a decorator fires.
- *
- * @param ctor - Model constructor to inspect.
- * @returns Array of FieldDefinition objects (one per user-defined property).
- */
-declare function getFields(ctor: DecoratedModelCtor): FieldDefinition[];
-/**
- * Get all index definitions for a Record subclass (from `@Indexed` decorators).
- *
- * @param ctor - Model constructor to inspect.
- * @returns Array of IndexDefinition objects.
- */
-declare function getIndexes(ctor: DecoratedModelCtor): IndexDefinition[];
-/**
- * Reset derived decorator caches (fieldsCache and indexesCache).
- *
- * Called by `Registry.reset()` during testing to ensure a clean state.
- * Primary metadata (`fieldMeta` and `indexedMeta`) is set at class-definition
- * time by decorators and must NOT be cleared here — only derived caches.
- */
-declare function resetDecoratorCaches(): void;
-/**
- * Public decorator utility class.
- *
- * Wraps the three property decorators and two discovery functions
- * as static methods, following the SheetORM one-export-per-file pattern.
- */
-export declare class Decorators {
-    /** Property decorator: mark a field for secondary indexing. */
-    static Indexed: typeof Indexed;
-    /** Property decorator: mark a field as required (shorthand). */
-    static Required: typeof Required;
-    /** Property decorator: set explicit field metadata. */
-    static Field: typeof Field;
-    /** Discover all field definitions for a model class. */
-    static getFields: typeof getFields;
-    /** Discover all index definitions for a model class. */
-    static getIndexes: typeof getIndexes;
-    /** Reset derived caches (for testing). */
-    static resetDecoratorCaches: typeof resetDecoratorCaches;
-}
-export {};
-//# sourceMappingURL=Decorators.d.ts.map

package/dist/npm/core/Decorators.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Decorators.d.ts","sourceRoot":"","sources":["../../../src/core/Decorators.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,wFAAwF;AACxF,UAAU,kBAAkB;IAC1B,QAAQ,MAAM,CAAC;CAChB;AAmDD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,OAAO,CAAC,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAYvG;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,QAAQ,IAAI,iBAAiB,CAKrC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,iBAAS,KAAK,CAAC,OAAO,CAAC,EAAE;IACvB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,iBAAiB,CAKpB;AAID;;;;;;;;;;;;;GAaG;AACH,iBAAS,SAAS,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,EAAE,CAgC9D;AAED;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,EAAE,CAK/D;AAED;;;;;;GAMG;AACH,iBAAS,oBAAoB,IAAI,IAAI,CAGpC;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,+DAA+D;IAC/D,MAAM,CAAC,OAAO,iBAAW;IAEzB,gEAAgE;IAChE,MAAM,CAAC,QAAQ,kBAAY;IAE3B,uDAAuD;IACvD,MAAM,CAAC,KAAK,eAAS;IAErB,wDAAwD;IACxD,MAAM,CAAC,SAAS,mBAAa;IAE7B,wDAAwD;IACxD,MAAM,CAAC,UAAU,oBAAc;IAE/B,0CAA0C;IAC1C,MAAM,CAAC,oBAAoB,8BAAwB;CACpD"}