@rsc-kit/press 0.0.0-stage → 0.30.42

package/dist/forms/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/forms/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA","sourcesContent":["export { defineForm } from './form.js'\nexport type { FormDefinition, PublicForm } from './form.js'\nexport type { FormsTheme, PublicFormProps } from './theme.js'\n"]}

package/dist/forms/registry.d.ts

@@ -0,0 +1,10 @@
+import type { Field, FormSchema } from '../resource.js';
+export interface FormHandle {
+    name: string;
+    schema: FormSchema;
+    fields: Field[];
+    handle: (values: Record<string, unknown>) => void | Promise<void>;
+    redirect: string | null;
+}
+export declare function registerForm(form: FormHandle): void;
+export declare function formNamed(name: string): FormHandle;

package/dist/forms/registry.js

@@ -0,0 +1,17 @@
+/**
+ * Forms by name. An action receives a name, not a form - only what can be
+ * serialised crosses to the browser and back - so the form is looked up here.
+ * On globalThis because a dev server can evaluate this module more than once.
+ */
+const KEY = Symbol.for('@rsc-kit/press.forms');
+const forms = (globalThis[KEY] ??= new Map());
+export function registerForm(form) {
+    forms.set(form.name, form);
+}
+export function formNamed(name) {
+    const form = forms.get(name);
+    if (!form)
+        throw new Error(`[forms] no form named ${name}; defineForm({ name: ${JSON.stringify(name)} }) has not run`);
+    return form;
+}
+//# sourceMappingURL=registry.js.map

package/dist/forms/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/forms/registry.ts"],"names":[],"mappings":"AAUA;;;;GAIG;AACH,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAC9C,MAAM,KAAK,GAA4B,CAAE,UAAsC,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,EAAE,CAA4B,CAAA;AAE9H,MAAM,UAAU,YAAY,CAAC,IAAgB;IAC3C,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAC5B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAE5B,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAEtH,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["import type { Field, FormSchema } from '../resource.js'\n\nexport interface FormHandle {\n  name: string\n  schema: FormSchema\n  fields: Field[]\n  handle: (values: Record<string, unknown>) => void | Promise<void>\n  redirect: string | null\n}\n\n/**\n * Forms by name. An action receives a name, not a form - only what can be\n * serialised crosses to the browser and back - so the form is looked up here.\n * On globalThis because a dev server can evaluate this module more than once.\n */\nconst KEY = Symbol.for('@rsc-kit/press.forms')\nconst forms: Map<string, FormHandle> = ((globalThis as Record<symbol, unknown>)[KEY] ??= new Map()) as Map<string, FormHandle>\n\nexport function registerForm(form: FormHandle): void {\n  forms.set(form.name, form)\n}\n\nexport function formNamed(name: string): FormHandle {\n  const form = forms.get(name)\n\n  if (!form) throw new Error(`[forms] no form named ${name}; defineForm({ name: ${JSON.stringify(name)} }) has not run`)\n\n  return form\n}\n"]}

package/dist/forms/theme.d.ts

@@ -0,0 +1,29 @@
+import type { ComponentType } from 'react';
+import type { Field } from '../resource.js';
+/**
+ * What a theme draws for a public form. As with a panel, every prop is data,
+ * a bound server action or a string - never a component - so the form may be
+ * a client component, and it is: it shows the browser's checks and the
+ * server's refusals under their fields.
+ */
+export interface FormsTheme {
+    PublicForm: ComponentType<PublicFormProps>;
+}
+export interface PublicFormProps {
+    /** Checks and sends the form. A refusal is a 422 whose messages belong under their fields. */
+    action: (form: FormData) => Promise<unknown>;
+    fields: Field[];
+    /** The submit button's words: Send message. */
+    submit: string;
+    /**
+     * What the visitor reads once it is sent, in place of the form. Absent when
+     * the form redirects instead.
+     */
+    done?: string;
+    /**
+     * The name of a field people never see and bots fill in. The theme renders
+     * it hidden from sight, from screen readers and from the tab order, with
+     * autocomplete off; a submission with it filled is thanked and dropped.
+     */
+    honeypot: string;
+}

package/dist/forms/theme.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=theme.js.map

package/dist/forms/theme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.js","sourceRoot":"","sources":["../../src/forms/theme.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentType } from 'react'\nimport type { Field } from '../resource.js'\n\n/**\n * What a theme draws for a public form. As with a panel, every prop is data,\n * a bound server action or a string - never a component - so the form may be\n * a client component, and it is: it shows the browser's checks and the\n * server's refusals under their fields.\n */\nexport interface FormsTheme {\n  PublicForm: ComponentType<PublicFormProps>\n}\n\nexport interface PublicFormProps {\n  /** Checks and sends the form. A refusal is a 422 whose messages belong under their fields. */\n  action: (form: FormData) => Promise<unknown>\n  fields: Field[]\n  /** The submit button's words: Send message. */\n  submit: string\n  /**\n   * What the visitor reads once it is sent, in place of the form. Absent when\n   * the form redirects instead.\n   */\n  done?: string\n  /**\n   * The name of a field people never see and bots fill in. The theme renders\n   * it hidden from sight, from screen readers and from the tab order, with\n   * autocomplete off; a submission with it filled is thanked and dropped.\n   */\n  honeypot: string\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { defineResource, fieldsOf, humanize, parse, valuesFrom } from './resource.js';
+export type { BulkAction, Column, ColumnBuilder, Columns, DataSource, BlockSpec, Field, FieldType, Filter, FieldOverride, FormSchema, Format, ListQuery, Option, Parsed, ParseOptions, Resource, ResourceDefinition, SourceContext, TableMode, ValuesOf, Tenant, } from './resource.js';
+export { IMAGE_TYPES } from './uploads.js';
+export type { Storage, StorageContext } from './uploads.js';
+export { Blocks, defineBlock } from './blocks.js';
+export type { Block, BlockDefinition, BlockValue } from './blocks.js';
+export { memorySource } from './memory.js';
+export { perTenant } from './tenant.js';
+export { definePlugin } from './plugin.js';
+export type { PanelPlugin, RecordChange, Widget } from './plugin.js';
+export { memoryInstallations, manifestProblems, publicHttps } from './installable.js';
+export type { Installation, Installations, Installs, ManifestColumn, ManifestProperty, ManifestResource, PluginManifest, PluginRequest } from './installable.js';

package/dist/index.js

@@ -0,0 +1,8 @@
+export { defineResource, fieldsOf, humanize, parse, valuesFrom } from './resource.js';
+export { IMAGE_TYPES } from './uploads.js';
+export { Blocks, defineBlock } from './blocks.js';
+export { memorySource } from './memory.js';
+export { perTenant } from './tenant.js';
+export { definePlugin } from './plugin.js';
+export { memoryInstallations, manifestProblems, publicHttps } from './installable.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAyBrF,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA","sourcesContent":["export { defineResource, fieldsOf, humanize, parse, valuesFrom } from './resource.js'\nexport type {\n  BulkAction,\n  Column,\n  ColumnBuilder,\n  Columns,\n  DataSource,\n  BlockSpec,\n  Field,\n  FieldType,\n  Filter,\n  FieldOverride,\n  FormSchema,\n  Format,\n  ListQuery,\n  Option,\n  Parsed,\n  ParseOptions,\n  Resource,\n  ResourceDefinition,\n  SourceContext,\n  TableMode,\n  ValuesOf,\n  Tenant,\n} from './resource.js'\nexport { IMAGE_TYPES } from './uploads.js'\nexport type { Storage, StorageContext } from './uploads.js'\nexport { Blocks, defineBlock } from './blocks.js'\nexport type { Block, BlockDefinition, BlockValue } from './blocks.js'\nexport { memorySource } from './memory.js'\nexport { perTenant } from './tenant.js'\nexport { definePlugin } from './plugin.js'\nexport type { PanelPlugin, RecordChange, Widget } from './plugin.js'\nexport { memoryInstallations, manifestProblems, publicHttps } from './installable.js'\nexport type { Installation, Installations, Installs, ManifestColumn, ManifestProperty, ManifestResource, PluginManifest, PluginRequest } from './installable.js'\n"]}

package/dist/installable.d.ts

@@ -0,0 +1,173 @@
+import type { RecordChange } from './plugin.js';
+import type { Format, FormSchema, ListQuery, Resource, SourceContext, Tenant } from './resource.js';
+/** A plugin, as it describes itself at its manifest url. */
+export interface PluginManifest {
+    /** Lowercase letters, digits and dashes; unique within a tenant. */
+    name: string;
+    label: string;
+    description?: string;
+    version?: string;
+    /** Where the panel POSTs every call. Same origin as the manifest. */
+    endpoint: string;
+    /** What it may see of the app's own resources: read:<resource>. */
+    scopes: string[];
+    resources: ManifestResource[];
+    /** Resources whose changes it is told about: its own, or ones it may read. */
+    events?: string[];
+}
+export type ManifestFormat = Exclude<Format, 'relation'>;
+export interface ManifestColumn {
+    key: string;
+    label?: string;
+    format?: ManifestFormat;
+    /** Shown by that resource's title: one of the plugin's own, or one it may read. */
+    relation?: string;
+    sortable?: boolean;
+    searchable?: boolean;
+}
+/** The JSON Schema a manifest's form is written in: flat, one level, scalar fields. */
+export interface ManifestProperty {
+    type: 'string' | 'number' | 'integer' | 'boolean';
+    format?: 'email' | 'date' | 'date-time' | 'textarea';
+    enum?: string[];
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    /** For the browser's pattern attribute only: the plugin checks it, not the panel. */
+    pattern?: string;
+    title?: string;
+    description?: string;
+    /** A belongsTo, drawn as a select of that resource's rows. */
+    relation?: string;
+}
+export interface ManifestResource {
+    name: string;
+    label?: string;
+    singular?: string;
+    key: string;
+    title: string;
+    description?: string;
+    columns: ManifestColumn[];
+    form: {
+        type: 'object';
+        properties: Record<string, ManifestProperty>;
+        required?: string[];
+    };
+    filters?: string[];
+    perPage?: number;
+    mode?: 'server' | 'client';
+    readOnly?: boolean;
+    bulkActions?: {
+        name: string;
+        label: string;
+        done?: string;
+        destructive?: boolean;
+    }[];
+}
+/** One plugin installed for one tenant. The secret signs every call to it. */
+export interface Installation {
+    /** Random; the plugin finds this installation's secret by it. */
+    id: string;
+    manifestUrl: string;
+    manifest: PluginManifest;
+    secret: string;
+    /** Until someone confirms they copied the secret into the plugin, the plugins page shows it. */
+    secretSeen: boolean;
+    installedAt: string;
+}
+/**
+ * Where installations are kept: the app's database, in a real app. Each call
+ * names the tenant, and a store answers for that tenant alone - one team's
+ * installs never reach another's panel. Keep `secret` encrypted at rest.
+ */
+export interface Installations {
+    list(tenant: Tenant | null): Promise<Installation[]>;
+    add(tenant: Tenant | null, installation: Installation): Promise<void>;
+    remove(tenant: Tenant | null, id: string): Promise<void>;
+    /** The secret was copied into the plugin; stop showing it. */
+    seen(tenant: Tenant | null, id: string): Promise<void>;
+}
+export interface Installs {
+    store: Installations;
+    /**
+     * Whether the panel may call this url: a manifest's, and so its endpoint's.
+     * By default https to a public host name - not localhost, not an address.
+     * The panel's server makes the request, so a url that reaches your own
+     * network is the thing to refuse; allow what your plugins are, and in
+     * development, localhost.
+     */
+    allow?: (url: URL) => boolean;
+    /** Who may install and uninstall. The panel's authorize by default; an owner, usually. */
+    manage?: () => boolean | Promise<boolean>;
+}
+/** Installations in memory: for a demo, a test, a single process. Gone on restart. */
+export declare function memoryInstallations(name?: string): Installations;
+/** The panel's own url segments under its path, which no resource may take. */
+export declare const RESERVED: string[];
+/**
+ * Every problem with a manifest, or none. Checked when it is reviewed, when it
+ * is installed, and on every request after - the app's resources can change
+ * under an installed plugin, and one that no longer fits is left out.
+ */
+export declare function manifestProblems(manifest: unknown, manifestUrl: string, host: string[]): string[];
+/** The scopes, as the person installing reads them. */
+export declare function scopeWords(manifest: PluginManifest, labelOf: (resource: string) => string): string[];
+/** Https to a name: not localhost, and not an address, which is how a private network is reached by url. */
+export declare function publicHttps(url: URL): boolean;
+/** A manifest, fetched and checked. Redirects are refused: a url allowed once must not lead somewhere that was not. */
+export declare function fetchManifest(manifestUrl: string, allow: (url: URL) => boolean, host: string[]): Promise<PluginManifest>;
+/** A stable digest of a manifest: what was reviewed is what is installed, or the install is refused. */
+export declare function digestOf(manifest: PluginManifest): Promise<string>;
+export declare function newInstallation(manifestUrl: string, manifest: PluginManifest): Installation;
+/** What a plugin's endpoint is sent. `tenant` is the installation's, never one the browser named. */
+export type PluginCall = {
+    type: 'list';
+    resource: string;
+    query: ListQuery;
+} | {
+    type: 'find';
+    resource: string;
+    id: string;
+} | {
+    type: 'create';
+    resource: string;
+    values: Record<string, unknown>;
+} | {
+    type: 'update';
+    resource: string;
+    id: string;
+    values: Record<string, unknown>;
+} | {
+    type: 'delete';
+    resource: string;
+    id: string;
+} | {
+    type: 'bulk';
+    resource: string;
+    action: string;
+    ids: string[];
+} | {
+    type: 'change';
+    change: RecordChange;
+};
+export type PluginRequest = PluginCall & {
+    tenant: Tenant | null;
+};
+/**
+ * One signed call. A 404 is null; a 422 with `{ errors: { field: [message] } }`
+ * is the form's field errors, exactly as Laravel's are; anything else that is
+ * not a 2xx is a failure with the plugin's name on it.
+ */
+export declare function callPlugin(installation: Installation, call: PluginCall, context: SourceContext, allow: (url: URL) => boolean, timeout?: number): Promise<unknown>;
+/**
+ * A Standard Schema from the manifest's JSON Schema, so a plugin's form goes
+ * through the same parse as any other. It checks what is cheap and safe to
+ * check here - types, required, enums, lengths, bounds - and never `pattern`;
+ * the plugin's endpoint checks everything again and answers 422.
+ */
+export declare function jsonSchemaForm(form: ManifestResource['form']): FormSchema;
+/** An installation's resources, as the panel's own. */
+export declare function resourcesOf(installation: Installation, allow: (url: URL) => boolean): Resource[];
+/** Whether a plugin is told about a change: one of its events, which its scopes or ownership allow. */
+export declare function wantsChange(installation: Installation, change: RecordChange): boolean;