@byline/core 0.9.3

package/dist/@types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export * from './admin-types.js';
+export * from './collection-types.js';
+export * from './db-types.js';
+export * from './field-data-types.js';
+export * from './field-types.js';
+export * from './populate-types.js';
+export * from './query-predicate.js';
+export * from './site-config.js';
+export * from './storage-types.js';
+export * from './store-types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/@types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/@types/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA"}

package/dist/@types/index.js

@@ -0,0 +1,18 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export * from './admin-types.js';
+export * from './collection-types.js';
+export * from './db-types.js';
+export * from './field-data-types.js';
+export * from './field-types.js';
+export * from './populate-types.js';
+export * from './query-predicate.js';
+export * from './site-config.js';
+export * from './storage-types.js';
+export * from './store-types.js';
+//# sourceMappingURL=index.js.map

package/dist/@types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/@types/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA"}

package/dist/@types/populate-types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+/**
+ * Pure type aliases for the populate DSL. The runtime orchestrator
+ * (`populateDocuments`) lives in `services/populate.ts` and re-exports
+ * these for backward compatibility, but they live here so other type
+ * surfaces — notably `CollectionAdminConfig.preview.populate` — can
+ * reference them without importing the services layer (which would
+ * create a cycle, since `populate.ts` imports from this folder).
+ */
+/**
+ * Per-field populate options. `select` names the target's fields to
+ * load (merged with the target's identity field so UI always has a
+ * label to render); `populate` nests for deeper relations.
+ *
+ * Use the `'*'` sub-spec shorthand instead when you want the full
+ * target document — `select` is strictly for explicit field lists.
+ */
+export interface PopulateFieldOptions {
+    select?: string[];
+    populate?: PopulateMap;
+}
+/**
+ * Per-relation projection selector.
+ *
+ * - `true` → default projection (identity field only; metadata is free).
+ * - `'*'`  → full document (every field loaded).
+ * - `{ select: [...] }` or `{ populate: {...} }` → explicit options.
+ */
+export type PopulateFieldSpec = true | '*' | PopulateFieldOptions;
+/**
+ * Top-level populate spec. Keys are relation field names (matched
+ * anywhere in the source document's field tree, including inside
+ * `group` / `array` / `blocks` structures).
+ */
+export type PopulateMap = Record<string, PopulateFieldSpec>;
+/**
+ * Top-level populate spec. Three shapes:
+ *
+ *   - `true`        → populate every relation leaf encountered, with
+ *                     default projection (identity only) at every level.
+ *   - `'*'`         → populate every relation leaf, with full projection
+ *                     at every level. Symmetric with the sub-spec `'*'`
+ *                     shorthand.
+ *   - `PopulateMap` → populate only the named relations, with per-field
+ *                     projection selectors.
+ */
+export type PopulateSpec = true | '*' | PopulateMap;
+//# sourceMappingURL=populate-types.d.ts.map

package/dist/@types/populate-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"populate-types.d.ts","sourceRoot":"","sources":["../../src/@types/populate-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE,WAAW,CAAA;CACvB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,GAAG,GAAG,GAAG,oBAAoB,CAAA;AAEjE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE3D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,GAAG,GAAG,WAAW,CAAA"}

package/dist/@types/populate-types.js

@@ -0,0 +1,9 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export {};
+//# sourceMappingURL=populate-types.js.map

package/dist/@types/populate-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"populate-types.js","sourceRoot":"","sources":["../../src/@types/populate-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/@types/query-predicate.d.ts

@@ -0,0 +1,74 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+/**
+ * Comparison operators usable on a single field-level predicate value. The
+ * parser normalises a bare value (`'foo'`) to `{ $eq: 'foo' }`; an operator
+ * object is taken as-is and the first declared operator wins.
+ */
+export interface FilterOperators {
+    $eq?: string | number | boolean | null;
+    $ne?: string | number | boolean | null;
+    $gt?: string | number;
+    $gte?: string | number;
+    $lt?: string | number;
+    $lte?: string | number;
+    $contains?: string;
+    $in?: Array<string | number>;
+    $nin?: Array<string | number>;
+}
+/**
+ * The value side of a predicate entry. Either a bare value (interpreted as
+ * `$eq`), an operator object, a nested `QueryPredicate` (for cross-collection
+ * relation filters or combinator children), or an array of `QueryPredicate`
+ * (the value side of `$and` / `$or`).
+ */
+export type PredicateValue = string | number | boolean | null | FilterOperators | QueryPredicate | QueryPredicate[];
+/**
+ * Structured predicate language used by:
+ *   - the client API's `where` clause (re-exported as `WhereClause`),
+ *   - the `CollectionHooks.beforeRead` hook return value.
+ *
+ * Keys are field names declared on the collection, with three exceptions:
+ *
+ *   - `$and: QueryPredicate[]` — every child must match.
+ *   - `$or:  QueryPredicate[]` — at least one child must match.
+ *   - reserved client-side keys (`status`, `query`, `path`) that the
+ *     `parseWhere` parser maps to document-level columns at the top level.
+ *     `beforeRead` predicates may use these too, with the same semantics.
+ *
+ * Field-name keys resolve through `field-store-map` and compile into the
+ * existing `EXISTS` / `LEFT JOIN LATERAL` SQL machinery — no new SQL
+ * primitives. Combinators nest freely:
+ *
+ * ```ts
+ * {
+ *   $or: [
+ *     { status: 'published' },
+ *     { status: 'draft', authorId: actor.id },
+ *   ],
+ * }
+ * ```
+ *
+ * Returning `undefined` from `beforeRead` means "no scoping". Use a
+ * sentinel predicate that yields no rows (e.g. `{ id: '__none__' }`)
+ * rather than throwing when the actor can read nothing — empty results
+ * are the correct shape for list endpoints.
+ */
+export interface QueryPredicate {
+    $and?: QueryPredicate[];
+    $or?: QueryPredicate[];
+    [key: string]: PredicateValue | undefined;
+}
+export type SortDirection = 'asc' | 'desc';
+/**
+ * A sort specification — `{ fieldName: direction }`. Field names resolve
+ * through `field-store-map` to a LATERAL JOIN; document-level columns
+ * (`createdAt`, `updatedAt`, `path`) compile to a direct `ORDER BY`.
+ */
+export type SortSpec = Record<string, SortDirection>;
+//# sourceMappingURL=query-predicate.d.ts.map

package/dist/@types/query-predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-predicate.d.ts","sourceRoot":"","sources":["../../src/@types/query-predicate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IACtC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IACtC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;IAC5B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,eAAe,GACf,cAAc,GACd,cAAc,EAAE,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;IACvB,GAAG,CAAC,EAAE,cAAc,EAAE,CAAA;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;CAC1C;AAMD,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA"}

package/dist/@types/query-predicate.js

@@ -0,0 +1,9 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export {};
+//# sourceMappingURL=query-predicate.js.map

package/dist/@types/query-predicate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-predicate.js","sourceRoot":"","sources":["../../src/@types/query-predicate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/@types/site-config.d.ts

@@ -0,0 +1,212 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+import type { SessionProvider } from '@byline/auth';
+import type { SlugifierFn } from '../utils/slugify.js';
+import type { CollectionAdminConfig } from './admin-types.js';
+import type { CollectionDefinition } from './collection-types.js';
+import type { IDbAdapter } from './db-types.js';
+import type { RichTextEditorComponent, RichTextPopulateFn } from './field-types.js';
+import type { IStorageProvider } from './storage-types.js';
+export type DbAdapterFn = (args: {
+    connectionString: string;
+}) => IDbAdapter;
+/**
+ * URL path segments for the admin and (future) public API routes.
+ * Both values are optional on the input side — callers typically read the
+ * resolved shape via `resolveRoutes()` which fills in `'/admin'` and `'/api'`
+ * defaults.
+ */
+export interface RoutesConfig {
+    admin: string;
+    api: string;
+}
+/**
+ * Common configuration shared by the server and client. Contains only
+ * serializable, framework-agnostic properties — no React components, no
+ * database adapters, no storage providers.
+ */
+export interface BaseConfig {
+    serverURL: string;
+    i18n: {
+        interface: {
+            defaultLocale: string;
+            locales: string[];
+        };
+        content: {
+            defaultLocale: string;
+            locales: string[];
+        };
+    };
+    collections: CollectionDefinition[];
+    /**
+     * URL segments for admin and API routes. Both keys default to `/admin`
+     * and `/api` respectively — installations only set this when they want
+     * to mount the admin or API at a non-default path. Consumers should
+     * read these via `resolveRoutes()` so the defaults are always applied.
+     */
+    routes?: Partial<RoutesConfig>;
+}
+/**
+ * Client-side configuration. Extends BaseConfig with admin UI presentation
+ * config (React components, formatters, column definitions, etc.).
+ *
+ * Used by `defineClientConfig()` and consumed by admin UI routes.
+ */
+export interface ClientConfig extends BaseConfig {
+    /** Admin UI configuration for collections (client-side only). */
+    admin?: CollectionAdminConfig[];
+    /**
+     * Site-wide field-level UI defaults. Currently surfaces the richtext
+     * editor adapter slot — additional field-level defaults (custom
+     * widgets, formatters, etc.) can be registered here as the system grows.
+     *
+     * @example
+     * ```ts
+     * import { RichTextField } from '@byline/richtext-lexical'
+     *
+     * defineClientConfig({
+     *   // ...
+     *   fields: {
+     *     richText: { editor: RichTextField },
+     *   },
+     * })
+     * ```
+     */
+    fields?: {
+        /**
+         * Editor component used to render every `type: 'richText'` field. Per-field
+         * overrides via `FieldAdminConfig.components.Field` continue to take
+         * precedence over this site-wide default.
+         */
+        richText?: {
+            editor: RichTextEditorComponent;
+        };
+    };
+}
+/**
+ * Server-side configuration. Extends BaseConfig with database and storage
+ * adapters. Deliberately does NOT extend ClientConfig — the server has no
+ * knowledge of React components or admin UI presentation logic.
+ *
+ * Generic over `TAdminStore` so installations can thread an adapter-built
+ * admin store (users / roles / permissions / refresh tokens) through
+ * `initBylineCore()` without `@byline/core` depending on `@byline/admin` —
+ * which would invert the package dependency direction. Callers that
+ * consume admin functionality pass `AdminStore` from `@byline/admin`;
+ * callers that do not leave the default `unknown`.
+ */
+export interface ServerConfig<TAdminStore = unknown> extends BaseConfig {
+    db: IDbAdapter;
+    /**
+     * Site-wide default storage provider for upload-capable image/file
+     * fields.
+     *
+     * This is the fallback used when a field's own `UploadConfig.storage`
+     * is not set. Individual fields can override this by specifying
+     * `storage` inside their `upload` config block.
+     *
+     * Resolution order:
+     *   1. `field.upload.storage`   — per-field override
+     *   2. `ServerConfig.storage`   — site-wide default
+     *   3. 500 error if neither is set
+     *
+     * @example
+     * ```ts
+     * import { localStorageProvider } from '@byline/storage-local'
+     * storage: localStorageProvider({ uploadDir: './public/uploads', baseUrl: '/uploads' })
+     * ```
+     */
+    storage?: IStorageProvider;
+    /**
+     * Installation-wide slugifier used to derive `documentVersions.path`
+     * from the field named by `CollectionDefinition.useAsPath`.
+     *
+     * Falls back to the default `slugify` from `@byline/core` when not set.
+     * Must be pure and synchronous — it runs server-side at write time and
+     * client-side for live form preview, and the two must agree on output.
+     */
+    slugifier?: SlugifierFn;
+    /**
+     * Session provider for admin authentication. Optional in Phase 3 —
+     * installations without a provider configured simply can't sign in
+     * (sign-in / verify / refresh / revoke all require one); everything
+     * else continues to work. Phase 5 wires the admin server-fn middleware
+     * and will tighten this where authentication is required.
+     *
+     * The built-in `JwtSessionProvider` from `@byline/admin/auth` covers
+     * the default case. Alternative providers can adapt Lucia, better-auth,
+     * WorkOS, Clerk, or institutional SSO by implementing the
+     * `SessionProvider` interface from `@byline/auth` — those adapters
+     * should ship as separate packages rather than being added to
+     * `@byline/admin`.
+     *
+     * @example
+     * ```ts
+     * import { JwtSessionProvider } from '@byline/admin/auth'
+     * import { createAdminStore } from '@byline/db-postgres/admin'
+     *
+     * sessionProvider: new JwtSessionProvider({
+     *   store: createAdminStore(drizzleDb),
+     *   signingSecret: process.env.BYLINE_JWT_SECRET!,
+     * })
+     * ```
+     */
+    sessionProvider?: SessionProvider;
+    /**
+     * Adapter-built bundle of admin repositories (users / roles /
+     * permissions / refresh tokens). Typically constructed via the
+     * adapter's `createAdminStore(...)` factory and shared with the
+     * session provider so both sides talk to the same repository
+     * instances.
+     *
+     * Surfaced unchanged as `BylineCore.adminStore` so server fns, seeds,
+     * and future admin commands can reach it without holding a second
+     * reference or casting the adapter. Optional — installations without
+     * admin UI can leave it unset.
+     *
+     * @example
+     * ```ts
+     * import type { AdminStore } from '@byline/admin'
+     * import { createAdminStore } from '@byline/db-postgres/admin'
+     *
+     * const db = pgAdapter({ ... })
+     * const adminStore = createAdminStore(db.drizzle)
+     * const core = await initBylineCore<AdminStore>({ db, adminStore, ... })
+     * // core.adminStore is typed as AdminStore
+     * ```
+     */
+    adminStore?: TAdminStore;
+    /**
+     * Site-wide field-level server adapter slots. Mirrors
+     * `ClientConfig.fields` for the server side — each entry plugs an
+     * adapter package into a framework-managed read or write phase.
+     *
+     * @example
+     * ```ts
+     * import { lexicalEditorServer } from '@byline/richtext-lexical/server'
+     *
+     * defineServerConfig({
+     *   fields: {
+     *     richText: { populate: lexicalEditorServer({ getClient: getAdminBylineClient }) },
+     *   },
+     * })
+     * ```
+     */
+    fields?: {
+        /**
+         * Richtext server-side populate function. Invoked by the read pipeline
+         * for every rich-text field whose effective `populateRelationsOnRead`
+         * is `true`. Required when any collection has a `richText` field
+         * configured to populate on read; `initBylineCore()` enforces this.
+         */
+        richText?: {
+            populate: RichTextPopulateFn;
+        };
+    };
+}
+//# sourceMappingURL=site-config.d.ts.map

package/dist/@types/site-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-config.d.ts","sourceRoot":"","sources":["../../src/@types/site-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE1D,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE;IAAE,gBAAgB,EAAE,MAAM,CAAA;CAAE,KAAK,UAAU,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE;QACJ,SAAS,EAAE;YACT,aAAa,EAAE,MAAM,CAAA;YACrB,OAAO,EAAE,MAAM,EAAE,CAAA;SAClB,CAAA;QACD,OAAO,EAAE;YACP,aAAa,EAAE,MAAM,CAAA;YACrB,OAAO,EAAE,MAAM,EAAE,CAAA;SAClB,CAAA;KACF,CAAA;IACD,WAAW,EAAE,oBAAoB,EAAE,CAAA;IACnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,iEAAiE;IACjE,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAC/B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE;QACP;;;;WAIG;QACH,QAAQ,CAAC,EAAE;YAAE,MAAM,EAAE,uBAAuB,CAAA;SAAE,CAAA;KAC/C,CAAA;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY,CAAC,WAAW,GAAG,OAAO,CAAE,SAAQ,UAAU;IACrE,EAAE,EAAE,UAAU,CAAA;IACd;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE;QACP;;;;;WAKG;QACH,QAAQ,CAAC,EAAE;YAAE,QAAQ,EAAE,kBAAkB,CAAA;SAAE,CAAA;KAC5C,CAAA;CACF"}

package/dist/@types/site-config.js

@@ -0,0 +1,9 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export {};
+//# sourceMappingURL=site-config.js.map

package/dist/@types/site-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../src/@types/site-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/@types/storage-types.d.ts

@@ -0,0 +1,86 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+/**
+ * The location metadata returned by a storage provider after a successful
+ * upload. These three values are stored in `store_file` alongside the rest of
+ * the file metadata.
+ */
+export interface StoredFileLocation {
+    /** Provider identifier string (e.g. `'local'`, `'s3'`). */
+    storageProvider: string;
+    /** Provider-internal path or object key for the stored file. */
+    storagePath: string;
+    /**
+     * Public or CDN URL for the file, if available.
+     * `null` when the provider requires a separate URL-generation step (e.g.
+     * signed S3 URLs generated at read-time).
+     */
+    storageUrl: string | null;
+}
+/**
+ * Options passed to `IStorageProvider.upload()` describing the file being
+ * stored.
+ */
+export interface UploadFileOptions {
+    /** Final stored filename (may differ from the original if sanitised). */
+    filename: string;
+    /** MIME type of the file (e.g. `'image/jpeg'`). */
+    mimeType: string;
+    /** File size in bytes. */
+    size: number;
+    /**
+     * The collection path the upload belongs to (e.g. `'media'`).
+     * Providers may use this to namespace storage paths.
+     */
+    collection?: string;
+}
+/**
+ * The pluggable file-storage interface.
+ *
+ * Implement this interface to add a new storage backend. Register the
+ * implementation in `ServerConfig.storage`.
+ *
+ * @example
+ * ```ts
+ * // In your server config (e.g. byline/server.config.ts):
+ * import { localStorageProvider } from '@byline/storage-local'
+ *
+ * defineServerConfig({
+ *   ...config,
+ *   db: pgAdapter({ connectionString: process.env.DB_CONNECTION_STRING! }),
+ *   storage: localStorageProvider({ uploadDir: './public/uploads', baseUrl: '/uploads' }),
+ * })
+ * ```
+ */
+export interface IStorageProvider {
+    /**
+     * A stable string identifier for this provider, stored in `store_file.storage_provider`.
+     * e.g. `'local'`, `'s3'`.
+     */
+    readonly providerName: string;
+    /**
+     * Store a file. The `stream` may be a Node.js `Readable` or a raw `Buffer`.
+     * Returns the location metadata to be recorded alongside the file entry.
+     */
+    upload(stream: NodeJS.ReadableStream | Buffer, options: UploadFileOptions): Promise<StoredFileLocation>;
+    /**
+     * Delete a previously stored file by its `storage_path`.
+     * Should resolve (not throw) if the file no longer exists.
+     */
+    delete(storagePath: string): Promise<void>;
+    /**
+     * Derive a public URL for a given `storagePath` at read-time.
+     *
+     * For providers that embed the URL in `StoredFileLocation.storageUrl` at
+     * upload time (e.g. a public S3 bucket), this can simply return the same
+     * value. For providers that generate signed/expiring URLs, implement the
+     * signing logic here.
+     */
+    getUrl(storagePath: string): string;
+}
+//# sourceMappingURL=storage-types.d.ts.map

package/dist/@types/storage-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-types.d.ts","sourceRoot":"","sources":["../../src/@types/storage-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAA;IACvB,gEAAgE;IAChE,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;;OAGG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,CAAC,cAAc,GAAG,MAAM,EACtC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAE9B;;;OAGG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1C;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;CACpC"}

package/dist/@types/storage-types.js

@@ -0,0 +1,9 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export {};
+//# sourceMappingURL=storage-types.js.map

package/dist/@types/storage-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-types.js","sourceRoot":"","sources":["../../src/@types/storage-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}