@org-quicko/silo-client 1.0.0 → 1.0.1

package/dist/index.js

@@ -678,96 +678,6 @@ class ProjectVariables {
   }
 }
 
-// src/entries/entry-mapper.ts
-class EntryMapper {
-  static fieldsOf(payload) {
-    const { id: _id, rev: _rev, created_at: _createdAt, updated_at: _updatedAt, ...fields } = payload;
-    return fields;
-  }
-  static toPayload(id, rev, fields, createdAt, updatedAt) {
-    return {
-      id,
-      rev,
-      ...fields,
-      created_at: createdAt.toISOString(),
-      updated_at: updatedAt.toISOString()
-    };
-  }
-}
-
-// src/entries/entry-base.ts
-class EntryBase {
-  context;
-  id;
-  rev;
-  createdAt;
-  updatedAt;
-  fields;
-  constructor(context, payload) {
-    this.context = context;
-    this.id = String(payload.id);
-    this.rev = Number(payload.rev);
-    this.createdAt = new Date(payload.created_at);
-    this.updatedAt = new Date(payload.updated_at);
-    this.fields = EntryMapper.fieldsOf(payload);
-  }
-  toJSON() {
-    return EntryMapper.toPayload(this.id, this.rev, this.fields, this.createdAt, this.updatedAt);
-  }
-  async delete(options = {}) {
-    await this.context.transport.empty({
-      method: "DELETE",
-      path: ApiPath.entry(this.context.project, this.context.environment, this.context.collection, this.id),
-      query: { rev: this.rev },
-      ...options
-    });
-  }
-}
-
-// src/entries/resolved-entry.ts
-class ResolvedEntry extends EntryBase {
-}
-
-// src/entries/entry.ts
-class Entry extends ResolvedEntry {
-  saving = false;
-  async save(options = {}) {
-    if (this.saving) {
-      throw new Error(`cannot save entry "${this.id}": a previous save() on this instance has not finished yet`);
-    }
-    this.saving = true;
-    try {
-      const payload = await this.context.transport.json({
-        method: "PUT",
-        path: ApiPath.entry(this.context.project, this.context.environment, this.context.collection, this.id),
-        query: { rev: this.rev, variables: "raw" },
-        body: this.fields,
-        ...options
-      });
-      this.adopt(payload);
-      return this;
-    } finally {
-      this.saving = false;
-    }
-  }
-  async refresh(options = {}) {
-    const payload = await this.context.transport.json({
-      method: "GET",
-      path: ApiPath.entry(this.context.project, this.context.environment, this.context.collection, this.id),
-      query: { variables: "raw" },
-      ...options
-    });
-    this.adopt(payload);
-    return this;
-  }
-  adopt(payload) {
-    this.rev = Number(payload.rev);
-    this.createdAt = new Date(payload.created_at);
-    this.updatedAt = new Date(payload.updated_at);
-    this.fields = EntryMapper.fieldsOf(payload);
-  }
-}
-
 // src/transport/page-payload.ts
 class PagePayload {
   static read(body) {
@@ -828,40 +738,39 @@ class EntryStream extends RowStream {
 
 // src/entries/entry-reader.ts
 class EntryReader {
-  context;
-  variables;
-  wrap;
-  constructor(context, variables, wrap) {
-    this.context = context;
-    this.variables = variables;
-    this.wrap = wrap;
-  }
-  async get(id, options = {}) {
-    const payload = await this.context.transport.json({
+  scope;
+  collection;
+  constructor(scope, collection) {
+    this.scope = scope;
+    this.collection = collection;
+  }
+  get(id, options = {}) {
+    const { variables, ...request } = options;
+    return this.scope.transport.json({
       method: "GET",
-      path: ApiPath.entry(this.context.project, this.context.environment, this.context.collection, id),
-      query: { variables: this.variables },
-      ...options
+      path: ApiPath.entry(this.scope.project, this.scope.environment, this.collection, id),
+      query: { variables },
+      ...request
     });
-    return this.wrap(payload);
   }
   async list(query = {}, options = {}) {
+    const { variables, ...request } = options;
     const loader = (window2) => this.list({ ...query, limit: window2.limit, offset: window2.offset }, options);
-    const body = await this.context.transport.json({
+    const body = await this.scope.transport.json({
       method: "GET",
-      path: ApiPath.entries(this.context.project, this.context.environment, this.context.collection),
+      path: ApiPath.entries(this.scope.project, this.scope.environment, this.collection),
       query: {
         limit: query.limit,
         offset: query.offset,
         filter: query.where?.toJSON(),
         sort: query.sort === undefined ? undefined : String(query.sort),
-        variables: this.variables
+        variables
       },
-      ...options
+      ...request
     });
     const page = PagePayload.read(body);
     const window = new PageWindow(page.limit ?? query.limit ?? 50, page.offset ?? query.offset ?? 0);
-    return new EntryPage(page.rows.map((payload) => this.wrap(payload)), page.total, window, loader);
+    return new EntryPage(page.rows, page.total, window, loader);
   }
   all(query = {}, options = {}) {
     const loader = async (window) => {
@@ -1035,15 +944,15 @@ class Search {
     const window = new PageWindow(page.limit ?? query.limit ?? 50, page.offset ?? query.offset ?? 0);
     const truncated = body.truncated === true;
     const engine = body.engine;
-    const hits = page.rows.map((hit) => this.toHit(hit));
+    const hits = page.rows.map((hit) => Search.toHit(hit));
     return new SearchPage(hits, page.total, window, truncated, engine, loader);
   }
-  toHit(payload) {
+  static toHit(payload) {
     return {
       project: payload.project,
       environment: payload.env,
       collection: payload.collection,
-      entry: new ResolvedEntry({ transport: this.transport, project: payload.project, environment: payload.env, collection: payload.collection }, payload.entry),
+      entry: payload.entry,
       snippets: payload.snippets
     };
   }
@@ -1106,36 +1015,24 @@ class CollectionHandle {
   name;
   filter = new TypedFilter;
   schema;
-  editable;
-  context;
-  resolved;
+  reader;
   constructor(scope, name) {
     this.scope = scope;
     this.name = name;
     this.schema = new CollectionSchema(scope, name);
-    this.context = {
-      transport: scope.transport,
-      project: scope.project,
-      environment: scope.environment,
-      collection: name
-    };
-    this.resolved = new EntryReader(this.context, undefined, (payload) => new ResolvedEntry(this.context, payload));
-    this.editable = new EntryReader(this.context, "raw", (payload) => new Entry(this.context, payload));
+    this.reader = new EntryReader(scope, name);
   }
   get(id, options = {}) {
-    return this.resolved.get(id, options);
-  }
-  edit(id, options = {}) {
-    return this.editable.get(id, options);
+    return this.reader.get(id, options);
   }
   list(query = {}, options = {}) {
-    return this.resolved.list(query, options);
+    return this.reader.list(query, options);
   }
   all(query = {}, options = {}) {
-    return this.resolved.all(query, options);
+    return this.reader.all(query, options);
   }
   pages(query = {}, options = {}) {
-    return this.resolved.pages(query, options);
+    return this.reader.pages(query, options);
   }
   create(fields, options = {}) {
     return this.write("POST", ApiPath.entries(this.scope.project, this.scope.environment, this.name), fields, undefined, options);
@@ -1165,23 +1062,14 @@ class CollectionHandle {
     });
     return RenameReport.fromWire(payload);
   }
-  async write(method, path, fields, rev, options) {
-    const payload = await this.scope.transport.json({
+  write(method, path, fields, rev, options) {
+    return this.scope.transport.json({
       method,
       path,
       query: { rev, variables: "raw" },
       body: fields,
       ...options
     });
-    return new Entry(this.context, payload);
-  }
-}
-
-// src/collections/reserved-field-names.ts
-class ReservedFieldNames {
-  static all = ["id", "rev", "seq", "created_at", "updated_at"];
-  static isReserved(name) {
-    return ReservedFieldNames.all.includes(name);
   }
 }
 
@@ -1200,7 +1088,6 @@ class Collections {
     return body.items.map(Collections.toSummary);
   }
   async create(name, schema, options = {}) {
-    Collections.warnOnReservedFields(schema);
     return this.scope.transport.json({
       method: "POST",
       path: ApiPath.collections(this.scope.project, this.scope.environment),
@@ -1218,13 +1105,6 @@ class Collections {
       updatedAt: new Date(payload.updated_at)
     };
   }
-  static warnOnReservedFields(schema) {
-    for (const name of Object.keys(schema.properties ?? {})) {
-      if (ReservedFieldNames.isReserved(name)) {
-        console.warn(`@org-quicko/silo-client: collection schema declares reserved field "${name}", which the server never returns`);
-      }
-    }
-  }
 }
 
 // src/variables/environment-variables.ts
@@ -2007,8 +1887,6 @@ export {
   Search,
   RowStream,
   RouteInventory,
-  ResolvedEntry,
-  ReservedFieldNames,
   RequestAbortedError,
   RenameReport,
   Projects,
@@ -2044,8 +1922,6 @@ export {
   EntryReader,
   EntryPageStream,
   EntryPage,
-  EntryBase,
-  Entry,
   ConflictError,
   Collections,
   CollectionSchema,

package/dist/search/search-hit.d.cts

@@ -1,18 +1,18 @@
-import type { ResolvedEntry } from "../entries/resolved-entry.cjs";
+import type { Entry } from "../entries/entry.cjs";
 import type { SearchSnippet } from "./search-snippet.cjs";
 /**
  * One result. The location sits on the hit rather than on the entry, which is
  * what lets a caller link to a result found outside the scope on screen, and
  * `environment` is mapped from the wire's `env`.
  *
- * The entry is always a `ResolvedEntry`: a result is not addressed to one
- * typed collection, so there is no `Fields` to give it, and it is not meant to
- * be edited from here — re-read through `collection.edit()` for that.
+ * The entry is untyped: a result is not addressed to one collection, so there
+ * is no `Fields` to give it. Its `{{NAME}}` templates are resolved, so read it
+ * again through `collection.get(id, { variables: "raw" })` before editing.
  */
 export interface SearchHit {
     readonly project: string;
     readonly environment: string;
     readonly collection: string;
-    readonly entry: ResolvedEntry<unknown>;
+    readonly entry: Entry;
     readonly snippets: readonly SearchSnippet[];
 }

package/dist/search/search-hit.d.ts

@@ -1,18 +1,18 @@
-import type { ResolvedEntry } from "../entries/resolved-entry.js";
+import type { Entry } from "../entries/entry.js";
 import type { SearchSnippet } from "./search-snippet.js";
 /**
  * One result. The location sits on the hit rather than on the entry, which is
  * what lets a caller link to a result found outside the scope on screen, and
  * `environment` is mapped from the wire's `env`.
  *
- * The entry is always a `ResolvedEntry`: a result is not addressed to one
- * typed collection, so there is no `Fields` to give it, and it is not meant to
- * be edited from here — re-read through `collection.edit()` for that.
+ * The entry is untyped: a result is not addressed to one collection, so there
+ * is no `Fields` to give it. Its `{{NAME}}` templates are resolved, so read it
+ * again through `collection.get(id, { variables: "raw" })` before editing.
  */
 export interface SearchHit {
     readonly project: string;
     readonly environment: string;
     readonly collection: string;
-    readonly entry: ResolvedEntry<unknown>;
+    readonly entry: Entry;
     readonly snippets: readonly SearchSnippet[];
 }

package/dist/search/search.d.cts

@@ -14,5 +14,8 @@ export declare class Search {
     private readonly reach;
     constructor(transport: Transport, reach: SearchReach);
     run(query: SearchQuery, options?: RequestOptions): Promise<SearchPage>;
-    private toHit;
+    /** `env` is the only rename: the hit's own location, which sits here rather
+     * than on the entry so a result found outside the scope on screen can still
+     * be linked to. */
+    private static toHit;
 }

package/dist/search/search.d.ts

@@ -14,5 +14,8 @@ export declare class Search {
     private readonly reach;
     constructor(transport: Transport, reach: SearchReach);
     run(query: SearchQuery, options?: RequestOptions): Promise<SearchPage>;
-    private toHit;
+    /** `env` is the only rename: the hit's own location, which sits here rather
+     * than on the entry so a result found outside the scope on screen can still
+     * be linked to. */
+    private static toHit;
 }

package/package.json

@@ -1,58 +1,58 @@
-{
-  "name": "@org-quicko/silo-client",
-  "version": "1.0.0",
-  "description": "A typed, object-oriented client for silo's HTTP API",
-  "keywords": [
-    "silo",
-    "cms",
-    "headless-cms",
-    "client",
-    "api"
-  ],
-  "homepage": "https://github.com/org-quicko/silo#silo-client",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/org-quicko/silo.git",
-    "directory": "packages/silo-client"
-  },
-  "license": "AGPL-3.0-or-later",
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "scripts": {
-    "build": "bun run build:esm && bun run build:cjs && bun run build:types",
-    "build:esm": "bun build src/index.ts --format=esm --outfile dist/index.js",
-    "build:cjs": "bun build src/index.ts --format=cjs --outfile dist/index.cjs",
-    "build:types": "tsc -p tsconfig.build.json && bun run tools/emit-cts-types.ts",
-    "test": "bun test",
-    "test:packaged": "bun run tools/packaged-tests.ts",
-    "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json",
-    "prepublishOnly": "bun run build"
-  },
-  "devDependencies": {
-    "@arethetypeswrong/cli": "^0.18.0",
-    "@silo/shared": "workspace:*",
-    "publint": "^0.3.0",
-    "typescript": "^7.0.2"
-  }
-}
+{
+  "name": "@org-quicko/silo-client",
+  "version": "1.0.1",
+  "description": "A typed, object-oriented client for silo's HTTP API",
+  "keywords": [
+    "silo",
+    "cms",
+    "headless-cms",
+    "client",
+    "api"
+  ],
+  "homepage": "https://github.com/org-quicko/silo#silo-client",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/org-quicko/silo.git",
+    "directory": "packages/silo-client"
+  },
+  "license": "AGPL-3.0-or-later",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "bun run build:esm && bun run build:cjs && bun run build:types",
+    "build:esm": "bun build src/index.ts --format=esm --outfile dist/index.js",
+    "build:cjs": "bun build src/index.ts --format=cjs --outfile dist/index.cjs",
+    "build:types": "tsc -p tsconfig.build.json && bun run tools/emit-cts-types.ts",
+    "test": "bun test",
+    "test:packaged": "bun run tools/packaged-tests.ts",
+    "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@silo/shared": "workspace:*",
+    "publint": "^0.3.24",
+    "typescript": "^7.0.2"
+  }
+}

package/dist/collections/reserved-field-names.d.cts

@@ -1,9 +0,0 @@
-/**
- * The five field names the server strips from every entry response before
- * answering, verified against `EntryUtils.toApiResponse`. A schema
- * declaring one still validates and stores it; it just never comes back.
- */
-export declare class ReservedFieldNames {
-    static readonly all: readonly string[];
-    static isReserved(name: string): boolean;
-}

package/dist/collections/reserved-field-names.d.ts

@@ -1,9 +0,0 @@
-/**
- * The five field names the server strips from every entry response before
- * answering, verified against `EntryUtils.toApiResponse`. A schema
- * declaring one still validates and stores it; it just never comes back.
- */
-export declare class ReservedFieldNames {
-    static readonly all: readonly string[];
-    static isReserved(name: string): boolean;
-}

package/dist/entries/entry-base.d.cts

@@ -1,31 +0,0 @@
-import type { RequestOptions } from "../request-options.cjs";
-import type { Transport } from "../transport/transport.cjs";
-import type { EntryPayload } from "./entry-payload.cjs";
-/** What an entry needs to address itself: the transport, and the scope and
- * collection its id lives in. */
-export interface EntryContext {
-    readonly transport: Transport;
-    readonly project: string;
-    readonly environment: string;
-    readonly collection: string;
-}
-/**
- * What every entry has regardless of whether it is editable: identity,
- * timestamps, its fields, a plain snapshot, and `delete()` — which needs
- * only an id and a rev, not the content. `rev`/`createdAt`/`updatedAt`/
- * `fields` are declared `readonly` here; {@link Entry} is the one subclass
- * that redeclares them mutable, since it is the one subclass with something
- * that legitimately changes them.
- */
-export declare abstract class EntryBase<Fields> {
-    protected readonly context: EntryContext;
-    readonly id: string;
-    readonly rev: number;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-    readonly fields: Fields;
-    constructor(context: EntryContext, payload: EntryPayload);
-    /** The flat wire shape, for logging or React state. */
-    toJSON(): EntryPayload;
-    delete(options?: RequestOptions): Promise<void>;
-}

package/dist/entries/entry-base.d.ts

@@ -1,31 +0,0 @@
-import type { RequestOptions } from "../request-options.js";
-import type { Transport } from "../transport/transport.js";
-import type { EntryPayload } from "./entry-payload.js";
-/** What an entry needs to address itself: the transport, and the scope and
- * collection its id lives in. */
-export interface EntryContext {
-    readonly transport: Transport;
-    readonly project: string;
-    readonly environment: string;
-    readonly collection: string;
-}
-/**
- * What every entry has regardless of whether it is editable: identity,
- * timestamps, its fields, a plain snapshot, and `delete()` — which needs
- * only an id and a rev, not the content. `rev`/`createdAt`/`updatedAt`/
- * `fields` are declared `readonly` here; {@link Entry} is the one subclass
- * that redeclares them mutable, since it is the one subclass with something
- * that legitimately changes them.
- */
-export declare abstract class EntryBase<Fields> {
-    protected readonly context: EntryContext;
-    readonly id: string;
-    readonly rev: number;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-    readonly fields: Fields;
-    constructor(context: EntryContext, payload: EntryPayload);
-    /** The flat wire shape, for logging or React state. */
-    toJSON(): EntryPayload;
-    delete(options?: RequestOptions): Promise<void>;
-}

package/dist/entries/entry-mapper.d.cts

@@ -1,13 +0,0 @@
-import type { EntryPayload } from "./entry-payload.cjs";
-/**
- * The one place an entry's envelope (`id`, `rev`, `created_at`, `updated_at`)
- * is split from its content. Never touches a field name either direction
- *: whatever is left after the four known keys are removed is handed
- * back exactly as it arrived.
- */
-export declare class EntryMapper {
-    static fieldsOf<Fields>(payload: EntryPayload): Fields;
-    /** The flat wire shape `toJSON()` answers: the envelope rebuilt around
-     * whatever `fields` currently holds. */
-    static toPayload<Fields>(id: string, rev: number, fields: Fields, createdAt: Date, updatedAt: Date): EntryPayload;
-}

package/dist/entries/entry-mapper.d.ts

@@ -1,13 +0,0 @@
-import type { EntryPayload } from "./entry-payload.js";
-/**
- * The one place an entry's envelope (`id`, `rev`, `created_at`, `updated_at`)
- * is split from its content. Never touches a field name either direction
- *: whatever is left after the four known keys are removed is handed
- * back exactly as it arrived.
- */
-export declare class EntryMapper {
-    static fieldsOf<Fields>(payload: EntryPayload): Fields;
-    /** The flat wire shape `toJSON()` answers: the envelope rebuilt around
-     * whatever `fields` currently holds. */
-    static toPayload<Fields>(id: string, rev: number, fields: Fields, createdAt: Date, updatedAt: Date): EntryPayload;
-}

package/dist/entries/entry-payload.d.cts

@@ -1,12 +0,0 @@
-/**
- * One entry exactly as the wire answers it: flattened, with the user's
- * fields alongside the four envelope keys. `EntryUtils.toApiResponse` is
- * where the server builds this shape.
- */
-export interface EntryPayload {
-    id: string;
-    rev: number;
-    created_at: string;
-    updated_at: string;
-    [field: string]: unknown;
-}

package/dist/entries/entry-payload.d.ts

@@ -1,12 +0,0 @@
-/**
- * One entry exactly as the wire answers it: flattened, with the user's
- * fields alongside the four envelope keys. `EntryUtils.toApiResponse` is
- * where the server builds this shape.
- */
-export interface EntryPayload {
-    id: string;
-    rev: number;
-    created_at: string;
-    updated_at: string;
-    [field: string]: unknown;
-}

package/dist/entries/resolved-entry.d.cts

@@ -1,11 +0,0 @@
-import { EntryBase } from "./entry-base.cjs";
-/**
- * A read whose variables have been substituted. Adds nothing over
- * {@link EntryBase}: no `save()`, no `refresh()` — writing a resolved value
- * back would overwrite whatever `{{NAME}}` template produced it. `fields` is
- * narrowed to `Readonly<Fields>` at the type level; `Entry` is what an
- * editor asks for instead.
- */
-export declare class ResolvedEntry<Fields> extends EntryBase<Fields> {
-    readonly fields: Readonly<Fields>;
-}

package/dist/entries/resolved-entry.d.ts

@@ -1,11 +0,0 @@
-import { EntryBase } from "./entry-base.js";
-/**
- * A read whose variables have been substituted. Adds nothing over
- * {@link EntryBase}: no `save()`, no `refresh()` — writing a resolved value
- * back would overwrite whatever `{{NAME}}` template produced it. `fields` is
- * narrowed to `Readonly<Fields>` at the type level; `Entry` is what an
- * editor asks for instead.
- */
-export declare class ResolvedEntry<Fields> extends EntryBase<Fields> {
-    readonly fields: Readonly<Fields>;
-}