@shapio/editor-sdk 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,174 @@
+import { DataType, DataTypeSettings, JsonValue, MEDIA_KINDS } from "@shapio/schema";
+import { ComponentType } from "react";
+//#region src/types.d.ts
+/**
+ * The contract between the Shapio admin and a field editor (brief §6, ADR 0009). Built-in editors and
+ * custom editors loaded at runtime from a project's `extensions/editors/*.js` receive exactly these props.
+ *
+ * An editor gets the field's value and metadata plus a small, explicit context. It never gets a network
+ * client, a session, tokens or secrets: everything it can do goes through `onChange` and the context
+ * functions. The server validates the value the same way whatever editor produced it.
+ *
+ * Bump EDITOR_CONTRACT_VERSION on any breaking change. The admin refuses editors built for another
+ * version and falls back to the field's built-in editor.
+ */
+export declare const EDITOR_CONTRACT_VERSION = 1;
+/** The rich-text envelope stored for `richtext` fields (ADR 0003). `doc` is ProseMirror JSON. */
+type RichTextValue = {
+  format: 'shapio-richtext';
+  version: number;
+  doc: {
+    type: 'doc';
+    content?: JsonValue[];
+  };
+};
+/** A component value: its fields keyed by API key. */
+type ComponentValue = {
+  [apiKey: string]: unknown;
+};
+/** A dynamic-zone item: a component value plus the component's API key in `__component`. */
+type DynamicZoneItem = ComponentValue & {
+  __component: string;
+};
+/**
+ * The value type of each data type, as the admin API reads and writes it. Dates and times are canonical
+ * UTC ISO-8601 text; decimals and big integers are strings so no precision is lost; relations and media
+ * are IDs (lists of IDs when the field holds several).
+ */
+type EditorValueMap = {
+  string: string;
+  text: string;
+  richtext: RichTextValue;
+  number: number;
+  integer: number;
+  decimal: string;
+  biginteger: string;
+  boolean: boolean;
+  date: string;
+  datetime: string;
+  time: string;
+  enum: string | string[];
+  json: JsonValue;
+  slug: string;
+  email: string;
+  url: string;
+  uid: string;
+  media: string | string[];
+  relation: string | string[];
+  component: ComponentValue | ComponentValue[];
+  dynamiczone: DynamicZoneItem[];
+};
+type EditorValue<T extends DataType = DataType> = EditorValueMap[T];
+/** The field being edited, from the active model definition. */
+type EditorField<T extends DataType = DataType> = {
+  /** Stable field ID (never changes when the field is renamed). */
+  id: string;
+  apiKey: string;
+  label: string;
+  description: string | undefined;
+  type: T;
+  required: boolean;
+  /** True when the value is per locale; false when it is shared by every locale of the entry. */
+  localized: boolean;
+  /** Type settings: validation rules (min, max, pattern...), enum values, relation target... */
+  settings: DataTypeSettings[T];
+  /** This editor's options, as configured on the field in the model builder. */
+  options: Readonly<Record<string, JsonValue>>;
+};
+/** The model (or component) the field belongs to. */
+type EditorModel = {
+  id: string;
+  apiKey: string;
+  label: string;
+  kind: 'collection' | 'singleton' | 'component';
+  localized: boolean;
+};
+type MediaKind = (typeof MEDIA_KINDS)[number];
+type MediaPickOptions = {
+  multiple?: boolean;
+  /** Restrict the picker to these kinds of files. */
+  allowedKinds?: readonly MediaKind[];
+};
+/** What the media picker hands back: enough to preview and reference an asset, never storage details. */
+type PickedMedia = {
+  id: string;
+  filename: string;
+  mimeType: string;
+  /** For previews in the admin only. Private assets have expiring URLs; store the `id`, never the URL. */
+  url: string;
+  alt: string;
+  width: number | null;
+  height: number | null;
+};
+/** The limited capabilities an editor may use. */
+type EditorContext = {
+  /** The content locale being edited, or null when the model is not localized. */
+  locale: string | null;
+  /** The entry being edited, or null for an entry that is not created yet. */
+  entryId: string | null;
+  /** The admin's interface language (e.g. `en`), for editors that ship their own strings. */
+  uiLanguage: string;
+  /** Opens the media library; resolves with the chosen assets, or null when the person cancels. */
+  pickMedia: (options?: MediaPickOptions) => Promise<PickedMedia[] | null>;
+  /** Translates one of the admin's own keys (e.g. `common.remove`); unknown keys return `fallback`. */
+  translate: (key: string, fallback: string, values?: Readonly<Record<string, string | number>>) => string;
+};
+type FieldValidationState = {
+  /** Server and client validation messages for this value, already translated. */
+  errors: readonly string[];
+  invalid: boolean;
+};
+type FieldEditorProps<T extends DataType = DataType> = {
+  /** The DOM id the field's label points at: put it on the editor's main focusable element. */
+  inputId: string;
+  /** The DOM id of the field's visible label: use `aria-labelledby` on group controls (radio groups...). */
+  labelId: string;
+  /** Ids of the description and error elements: pass to `aria-describedby`. */
+  describedBy: string | undefined;
+  /** The current value; null when the field is empty. */
+  value: EditorValue<T> | null;
+  /** Report a new value. Pass null to clear the field. */
+  onChange: (value: EditorValue<T> | null) => void;
+  /** Call when the editor loses focus (client-side checks run then). */
+  onBlur: () => void;
+  validation: FieldValidationState;
+  /** Shown but not editable (e.g. a field the person may not change). Keep the value selectable. */
+  readOnly: boolean;
+  /** Temporarily unavailable (e.g. while the entry is being saved or reloaded). */
+  disabled: boolean;
+  field: EditorField<T>;
+  model: EditorModel;
+  context: EditorContext;
+};
+/** A field editor: what a module in `extensions/editors/` exports (see `defineEditor`). */
+type EditorDefinition<T extends DataType = DataType> = {
+  /** Namespaced ID referenced from field definitions, e.g. `acme.starRating` (letters, digits, `_`, `-`). */
+  id: string;
+  /** The contract version the editor was built against (set by `defineEditor`). */
+  contractVersion: number;
+  /** Data types the editor can edit. */
+  dataTypes: readonly T[];
+  component: ComponentType<FieldEditorProps<T>>;
+};
+//#endregion
+//#region src/defineEditor.d.ts
+/**
+ * Declares a field editor. Export the result from your editor module as `editor`:
+ *
+ * ```tsx
+ * export const editor = defineEditor({
+ *   id: 'acme.starRating',
+ *   dataTypes: ['integer'],
+ *   component: StarRating,
+ * });
+ * ```
+ *
+ * It stamps the contract version the editor was built against, so the admin can refuse an editor built
+ * for an incompatible release instead of failing at runtime.
+ */
+export declare const defineEditor: <T extends DataType>(definition: Omit<EditorDefinition<T>, "contractVersion">) => EditorDefinition<T>;
+/** Runtime check of a module export (the admin's loader uses it on untrusted modules). */
+export declare const isEditorDefinition: (value: unknown) => value is EditorDefinition;
+//#endregion
+export type { ComponentValue, DynamicZoneItem, EditorContext, EditorDefinition, EditorField, EditorModel, EditorValue, EditorValueMap, FieldEditorProps, FieldValidationState, MediaKind, MediaPickOptions, PickedMedia, RichTextValue };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,46 @@
+//#region src/types.ts
+/**
+* The contract between the Shapio admin and a field editor (brief §6, ADR 0009). Built-in editors and
+* custom editors loaded at runtime from a project's `extensions/editors/*.js` receive exactly these props.
+*
+* An editor gets the field's value and metadata plus a small, explicit context. It never gets a network
+* client, a session, tokens or secrets: everything it can do goes through `onChange` and the context
+* functions. The server validates the value the same way whatever editor produced it.
+*
+* Bump EDITOR_CONTRACT_VERSION on any breaking change. The admin refuses editors built for another
+* version and falls back to the field's built-in editor.
+*/
+const EDITOR_CONTRACT_VERSION = 1;
+//#endregion
+//#region src/defineEditor.ts
+/** `vendor.name`, the same rule as `CUSTOM_EDITOR_ID_PATTERN` in @shapio/schema. */
+const EDITOR_ID_PATTERN = /^[A-Za-z][A-Za-z0-9_-]*(\.[A-Za-z][A-Za-z0-9_-]*)+$/;
+/**
+* Declares a field editor. Export the result from your editor module as `editor`:
+*
+* ```tsx
+* export const editor = defineEditor({
+*   id: 'acme.starRating',
+*   dataTypes: ['integer'],
+*   component: StarRating,
+* });
+* ```
+*
+* It stamps the contract version the editor was built against, so the admin can refuse an editor built
+* for an incompatible release instead of failing at runtime.
+*/
+const defineEditor = (definition) => {
+	if (!EDITOR_ID_PATTERN.test(definition.id)) throw new Error(`Editor ID "${definition.id}" must be namespaced like "acme.starRating" (letters, digits, _ and -)`);
+	if (definition.dataTypes.length === 0) throw new Error(`Editor "${definition.id}" must list at least one data type`);
+	return {
+		...definition,
+		contractVersion: 1
+	};
+};
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** Runtime check of a module export (the admin's loader uses it on untrusted modules). */
+const isEditorDefinition = (value) => isRecord(value) && typeof value.id === "string" && EDITOR_ID_PATTERN.test(value.id) && typeof value.contractVersion === "number" && Array.isArray(value.dataTypes) && value.dataTypes.every((type) => typeof type === "string") && (typeof value.component === "function" || isRecord(value.component));
+//#endregion
+export { EDITOR_CONTRACT_VERSION, defineEditor, isEditorDefinition };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/types.ts","../src/defineEditor.ts"],"sourcesContent":["import type { DataType, DataTypeSettings, JsonValue, MEDIA_KINDS } from '@shapio/schema';\nimport type { ComponentType } from 'react';\n\n/**\n * The contract between the Shapio admin and a field editor (brief §6, ADR 0009). Built-in editors and\n * custom editors loaded at runtime from a project's `extensions/editors/*.js` receive exactly these props.\n *\n * An editor gets the field's value and metadata plus a small, explicit context. It never gets a network\n * client, a session, tokens or secrets: everything it can do goes through `onChange` and the context\n * functions. The server validates the value the same way whatever editor produced it.\n *\n * Bump EDITOR_CONTRACT_VERSION on any breaking change. The admin refuses editors built for another\n * version and falls back to the field's built-in editor.\n */\nexport const EDITOR_CONTRACT_VERSION = 1;\n\n/** The rich-text envelope stored for `richtext` fields (ADR 0003). `doc` is ProseMirror JSON. */\nexport type RichTextValue = {\n  format: 'shapio-richtext';\n  version: number;\n  doc: { type: 'doc'; content?: JsonValue[] };\n};\n\n/** A component value: its fields keyed by API key. */\nexport type ComponentValue = { [apiKey: string]: unknown };\n\n/** A dynamic-zone item: a component value plus the component's API key in `__component`. */\nexport type DynamicZoneItem = ComponentValue & { __component: string };\n\n/**\n * The value type of each data type, as the admin API reads and writes it. Dates and times are canonical\n * UTC ISO-8601 text; decimals and big integers are strings so no precision is lost; relations and media\n * are IDs (lists of IDs when the field holds several).\n */\nexport type EditorValueMap = {\n  string: string;\n  text: string;\n  richtext: RichTextValue;\n  number: number;\n  integer: number;\n  decimal: string;\n  biginteger: string;\n  boolean: boolean;\n  date: string;\n  datetime: string;\n  time: string;\n  enum: string | string[];\n  json: JsonValue;\n  slug: string;\n  email: string;\n  url: string;\n  uid: string;\n  media: string | string[];\n  relation: string | string[];\n  component: ComponentValue | ComponentValue[];\n  dynamiczone: DynamicZoneItem[];\n};\n\nexport type EditorValue<T extends DataType = DataType> = EditorValueMap[T];\n\n/** The field being edited, from the active model definition. */\nexport type EditorField<T extends DataType = DataType> = {\n  /** Stable field ID (never changes when the field is renamed). */\n  id: string;\n  apiKey: string;\n  label: string;\n  description: string | undefined;\n  type: T;\n  required: boolean;\n  /** True when the value is per locale; false when it is shared by every locale of the entry. */\n  localized: boolean;\n  /** Type settings: validation rules (min, max, pattern...), enum values, relation target... */\n  settings: DataTypeSettings[T];\n  /** This editor's options, as configured on the field in the model builder. */\n  options: Readonly<Record<string, JsonValue>>;\n};\n\n/** The model (or component) the field belongs to. */\nexport type EditorModel = {\n  id: string;\n  apiKey: string;\n  label: string;\n  kind: 'collection' | 'singleton' | 'component';\n  localized: boolean;\n};\n\nexport type MediaKind = (typeof MEDIA_KINDS)[number];\n\nexport type MediaPickOptions = {\n  multiple?: boolean;\n  /** Restrict the picker to these kinds of files. */\n  allowedKinds?: readonly MediaKind[];\n};\n\n/** What the media picker hands back: enough to preview and reference an asset, never storage details. */\nexport type PickedMedia = {\n  id: string;\n  filename: string;\n  mimeType: string;\n  /** For previews in the admin only. Private assets have expiring URLs; store the `id`, never the URL. */\n  url: string;\n  alt: string;\n  width: number | null;\n  height: number | null;\n};\n\n/** The limited capabilities an editor may use. */\nexport type EditorContext = {\n  /** The content locale being edited, or null when the model is not localized. */\n  locale: string | null;\n  /** The entry being edited, or null for an entry that is not created yet. */\n  entryId: string | null;\n  /** The admin's interface language (e.g. `en`), for editors that ship their own strings. */\n  uiLanguage: string;\n  /** Opens the media library; resolves with the chosen assets, or null when the person cancels. */\n  pickMedia: (options?: MediaPickOptions) => Promise<PickedMedia[] | null>;\n  /** Translates one of the admin's own keys (e.g. `common.remove`); unknown keys return `fallback`. */\n  translate: (key: string, fallback: string, values?: Readonly<Record<string, string | number>>) => string;\n};\n\nexport type FieldValidationState = {\n  /** Server and client validation messages for this value, already translated. */\n  errors: readonly string[];\n  invalid: boolean;\n};\n\nexport type FieldEditorProps<T extends DataType = DataType> = {\n  /** The DOM id the field's label points at: put it on the editor's main focusable element. */\n  inputId: string;\n  /** The DOM id of the field's visible label: use `aria-labelledby` on group controls (radio groups...). */\n  labelId: string;\n  /** Ids of the description and error elements: pass to `aria-describedby`. */\n  describedBy: string | undefined;\n  /** The current value; null when the field is empty. */\n  value: EditorValue<T> | null;\n  /** Report a new value. Pass null to clear the field. */\n  onChange: (value: EditorValue<T> | null) => void;\n  /** Call when the editor loses focus (client-side checks run then). */\n  onBlur: () => void;\n  validation: FieldValidationState;\n  /** Shown but not editable (e.g. a field the person may not change). Keep the value selectable. */\n  readOnly: boolean;\n  /** Temporarily unavailable (e.g. while the entry is being saved or reloaded). */\n  disabled: boolean;\n  field: EditorField<T>;\n  model: EditorModel;\n  context: EditorContext;\n};\n\n/** A field editor: what a module in `extensions/editors/` exports (see `defineEditor`). */\nexport type EditorDefinition<T extends DataType = DataType> = {\n  /** Namespaced ID referenced from field definitions, e.g. `acme.starRating` (letters, digits, `_`, `-`). */\n  id: string;\n  /** The contract version the editor was built against (set by `defineEditor`). */\n  contractVersion: number;\n  /** Data types the editor can edit. */\n  dataTypes: readonly T[];\n  component: ComponentType<FieldEditorProps<T>>;\n};\n","import type { DataType } from '@shapio/schema';\nimport { EDITOR_CONTRACT_VERSION, type EditorDefinition } from './types.js';\n\n/** `vendor.name`, the same rule as `CUSTOM_EDITOR_ID_PATTERN` in @shapio/schema. */\nconst EDITOR_ID_PATTERN = /^[A-Za-z][A-Za-z0-9_-]*(\\.[A-Za-z][A-Za-z0-9_-]*)+$/;\n\n/**\n * Declares a field editor. Export the result from your editor module as `editor`:\n *\n * ```tsx\n * export const editor = defineEditor({\n *   id: 'acme.starRating',\n *   dataTypes: ['integer'],\n *   component: StarRating,\n * });\n * ```\n *\n * It stamps the contract version the editor was built against, so the admin can refuse an editor built\n * for an incompatible release instead of failing at runtime.\n */\nexport const defineEditor = <T extends DataType>(\n  definition: Omit<EditorDefinition<T>, 'contractVersion'>,\n): EditorDefinition<T> => {\n  if (!EDITOR_ID_PATTERN.test(definition.id)) {\n    throw new Error(\n      `Editor ID \"${definition.id}\" must be namespaced like \"acme.starRating\" (letters, digits, _ and -)`,\n    );\n  }\n  if (definition.dataTypes.length === 0) {\n    throw new Error(`Editor \"${definition.id}\" must list at least one data type`);\n  }\n  return { ...definition, contractVersion: EDITOR_CONTRACT_VERSION };\n};\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n  typeof value === 'object' && value !== null && !Array.isArray(value);\n\n/** Runtime check of a module export (the admin's loader uses it on untrusted modules). */\nexport const isEditorDefinition = (value: unknown): value is EditorDefinition =>\n  isRecord(value) &&\n  typeof value.id === 'string' &&\n  EDITOR_ID_PATTERN.test(value.id) &&\n  typeof value.contractVersion === 'number' &&\n  Array.isArray(value.dataTypes) &&\n  value.dataTypes.every((type) => typeof type === 'string') &&\n  (typeof value.component === 'function' || isRecord(value.component));\n"],"mappings":";;;;;;;;;;;;AAcA,MAAa,0BAA0B;;;;ACVvC,MAAM,oBAAoB;;;;;;;;;;;;;;;AAgB1B,MAAa,gBACX,eACwB;CACxB,IAAI,CAAC,kBAAkB,KAAK,WAAW,EAAE,GACvC,MAAM,IAAI,MACR,cAAc,WAAW,GAAG,uEAC9B;CAEF,IAAI,WAAW,UAAU,WAAW,GAClC,MAAM,IAAI,MAAM,WAAW,WAAW,GAAG,mCAAmC;CAE9E,OAAO;EAAE,GAAG;EAAY,iBAAA;CAAyC;AACnE;AAEA,MAAM,YAAY,UAChB,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;;AAGrE,MAAa,sBAAsB,UACjC,SAAS,KAAK,KACd,OAAO,MAAM,OAAO,YACpB,kBAAkB,KAAK,MAAM,EAAE,KAC/B,OAAO,MAAM,oBAAoB,YACjC,MAAM,QAAQ,MAAM,SAAS,KAC7B,MAAM,UAAU,OAAO,SAAS,OAAO,SAAS,QAAQ,MACvD,OAAO,MAAM,cAAc,cAAc,SAAS,MAAM,SAAS"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@shapio/editor-sdk",
+  "version": "0.2.0",
+  "description": "Contract and helpers for custom Shapio field editors loaded at runtime.",
+  "license": "Apache-2.0",
+  "homepage": "https://shapio.dev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mybrokengnome/shapio.git",
+    "directory": "packages/editor-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/mybrokengnome/shapio/issues"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "exports": {
+    ".": {
+      "@shapio/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@shapio/schema": "0.2.0"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "19.3.0",
+    "react": "19.3.0",
+    "tsdown": "0.23.0",
+    "typescript": "6.0.3",
+    "vitest": "5.0.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc -p tsconfig.json"
+  }
+}