@stripe/extensibility-custom-objects 0.7.4

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2026 Stripe, Inc. (https://stripe.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# @stripe/extensibility-custom-objects
+
+TypeScript decorators and runtime for defining Stripe custom objects.
+
+## Installation
+
+```bash
+npm install @stripe/extensibility-custom-objects
+npm install --save-dev @stripe/extensibility-custom-objects-tools
+```
+
+## Quick Start
+
+Define a custom object using the two-class pattern — a fields class for data and
+an outer class for behavior:
+
+```typescript
+import { CustomObject, CustomFields, Action } from '@stripe/extensibility-custom-objects';
+import { Field } from '@stripe/extensibility-jsonschema';
+
+@CustomFields
+export class ShipmentFields {
+  /** @primaryField @displayName Tracking Number */
+  trackingNumber!: string;
+
+  /** @secondaryField @displayName Delivered */
+  delivered!: boolean;
+
+  /** @displayName Weight (lbs) */
+  weightInLbs: number = 0;
+}
+
+/**
+ * @apiName shipment
+ * @displayName Shipment
+ */
+@CustomObject
+export class Shipment extends BaseObject<ShipmentFields> {
+  /**
+   * @apiName mark_delivered
+   * @displayName Mark Delivered
+   */
+  @Action
+  async markDelivered(): Promise<void> {
+    this.data.delivered = true;
+    await this.save();
+  }
+
+  /** @apiName export_manifest */
+  @Action
+  async exportManifest(): Promise<string> {
+    return `${this.data.trackingNumber}: ${this.data.weightInLbs}lbs`;
+  }
+}
+```
+
+Build your code:
+
+```bash
+custom-objects-build --input src --output dist
+```
+
+See [Custom Object DSL Reference](../../docs/custom-object-dsl.md) for full documentation.

package/dist/decorators/action.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Context type that restricts decorator application to instance methods only.
+ * Uses `{ readonly static: false }` to make TypeScript reject `@Action` on static methods.
+ *
+ * @public
+ */
+export type InstanceMethodDecoratorContext = { readonly static: false } & ClassMethodDecoratorContext;
+/**
+ * Marks an instance method as an action on a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the method in any way.
+ * It serves as a marker for the build-time transformer, which extracts action metadata
+ * and generates the necessary platform registration code.
+ *
+ * Can only be applied to instance methods, not static methods. Applying `@Action`
+ * to a static method is a TypeScript compile error.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the method: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName mark_delivered` and `@displayName Mark Delivered`,
+ * then apply the bare decorator `@Action`.
+ *
+ * @public
+ */
+export declare function Action(_target: (...args: never) => unknown, _context: InstanceMethodDecoratorContext): void;
+//# sourceMappingURL=action.d.ts.map

package/dist/decorators/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/decorators/action.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG,2BAA2B,GAAG;IACzE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CACpB,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,EACpC,QAAQ,EAAE,8BAA8B,GACvC,IAAI,CAEN"}

package/dist/decorators/custom-fields.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Marks a class as a custom fields container for a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which discovers the fields
+ * class by this decorator and extracts field metadata from its members.
+ *
+ * The fields class must contain only field declarations (no methods). Use
+ * TSDoc tags from `@stripe/extensibility-jsonschema` on each field to control
+ * display and validation. Exactly one field should be tagged `primaryField`
+ * and at most one `secondaryField`.
+ *
+ * @public
+ */
+export declare function CustomFields(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+//# sourceMappingURL=custom-fields.d.ts.map

package/dist/decorators/custom-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../../src/decorators/custom-fields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,QAAQ,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EACrD,QAAQ,EAAE,qBAAqB,GAC9B,IAAI,CAEN"}

package/dist/decorators/custom-object.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Marks a class as a custom object type.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which extracts metadata
+ * and generates the necessary platform registration code.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the class: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName installment_plan` and `@displayName Installment plan`,
+ * then apply the bare decorator `@CustomObject`.
+ *
+ * @public
+ */
+export declare function CustomObject(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+//# sourceMappingURL=custom-object.d.ts.map

package/dist/decorators/custom-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object.d.ts","sourceRoot":"","sources":["../../src/decorators/custom-object.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,QAAQ,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EACrD,QAAQ,EAAE,qBAAqB,GAC9B,IAAI,CAEN"}

package/dist/decorators/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Decorator types and functions for marking custom object classes and actions.
+ *
+ * All decorators in this module are **inert at runtime** — they serve as markers
+ * for the build-time transformer to extract metadata and generate platform
+ * registration code.
+ *
+ * @internal
+ */
+export { CustomObject } from './custom-object.js';
+export { CustomFields } from './custom-fields.js';
+export { Action } from './action.js';
+export type { InstanceMethodDecoratorContext } from './action.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/decorators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC"}

package/dist/extensibility-custom-objects-alpha.d.ts

@@ -0,0 +1,245 @@
+/**
+ * Stripe Custom Objects SDK
+ *
+ * Provides decorators and runtime support for defining custom object types
+ * that integrate with the Stripe platform. Custom objects are defined using
+ * TypeScript classes with decorators, then transformed at build time using
+ * `@stripe/extensibility-custom-objects-tools`.
+ *
+ * @packageDocumentation
+ */
+
+/* Excluded from this release type: __hasPendingChanges */
+
+/* Excluded from this release type: __queueSave */
+
+/**
+ * Marks an instance method as an action on a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the method in any way.
+ * It serves as a marker for the build-time transformer, which extracts action metadata
+ * and generates the necessary platform registration code.
+ *
+ * Can only be applied to instance methods, not static methods. Applying `@Action`
+ * to a static method is a TypeScript compile error.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the method: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName mark_delivered` and `@displayName Mark Delivered`,
+ * then apply the bare decorator `@Action`.
+ *
+ * @public
+ */
+export declare function Action(_target: (...args: never) => unknown, _context: InstanceMethodDecoratorContext): void;
+
+/* Excluded from this release type: _ActionMetadata */
+
+/* Excluded from this release type: _assemblePayload */
+
+/**
+ * Abstract base class for all custom objects.
+ *
+ * Provides built-in platform fields (id, object, created, updated, livemode)
+ * and a typed `fields` container for user-defined fields. The generic parameter
+ * `T` describes the shape of user fields accessible via `this.fields`.
+ *
+ * @remarks
+ * **Definite assignment assertions (`!`)**: All platform fields (`id`, `object`,
+ * `created`, `updated`, `livemode`, `fields`) use the TypeScript definite assignment
+ * assertion operator. This suppresses the "property has no initializer" error because
+ * these fields are intentionally left unset by the zero-argument constructor.
+ *
+ * The runtime (`executeInstanceMethod` in `invoke.ts`) is solely responsible for
+ * populating these fields via `Object.assign` and `hydrateInstance` **before** the
+ * dirty-tracking proxy is installed. Code that constructs a subclass directly
+ * (bypassing the runtime) will have `undefined` values for all platform fields at
+ * runtime, despite the types suggesting otherwise.
+ *
+ * @typeParam T - Shape of user-defined fields stored in `fields`
+ * @public
+ */
+export declare abstract class BaseObject<T extends Record<string, unknown> = Record<string, unknown>> {
+    /** Unique identifier assigned by the platform */
+    readonly id: string;
+    /** Object type identifier assigned by the platform */
+    readonly object: string;
+    /** Timestamp when the object was created */
+    readonly created: Date;
+    /** Timestamp when the object was last updated */
+    readonly updated: Date;
+    /** Whether the object exists in live mode (true) or test mode (false). @public */
+    readonly livemode: boolean;
+    /**
+     * User-defined fields container. Populated during hydration via Object.assign
+     * before the dirty-tracking proxy is installed.
+     * Access individual fields as `this.fields.fieldName`.
+     *
+     * @remarks
+     * The generic type `T` describes the shape of available fields after
+     * hydration, not at construction time. Fields may be undefined before
+     * the instance is hydrated with data from the platform.
+     *
+     * @public
+     */
+    readonly fields: T;
+    /**
+     * Flushes pending field mutations into the slated-updates accumulator.
+     *
+     * When called from a transformed action (no save handler configured), this
+     * records which fields were mutated so that the Logic wrapper can include them
+     * in the response envelope's `updatedFields`. No network call is made.
+     *
+     * When a save handler is configured (runtime invoke path), the handler is
+     * called for actual persistence and its result is returned.
+     *
+     * @returns The save result including `updatedFieldCount` (unique fields flushed)
+     * @throws Error if the object is not proxied
+     * @public
+     */
+    save(): Promise<SaveResult>;
+    /**
+     * Discard all pending changes and restore field values to their
+     * last-saved state. Has no effect if the object is not proxied.
+     *
+     * @public
+     */
+    revert(): void;
+}
+
+/* Excluded from this release type: _buildMethodResponse */
+
+/* Excluded from this release type: _clearRegistry */
+
+/* Excluded from this release type: _clearSlatedUpdates */
+
+/* Excluded from this release type: _commitProxyState */
+
+/* Excluded from this release type: _createEventEmitter */
+
+/* Excluded from this release type: _createInstanceProxy */
+
+/* Excluded from this release type: _CreateProxyOptions */
+
+/**
+ * Marks a class as a custom fields container for a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which discovers the fields
+ * class by this decorator and extracts field metadata from its members.
+ *
+ * The fields class must contain only field declarations (no methods). Use
+ * TSDoc tags from `@stripe/extensibility-jsonschema` on each field to control
+ * display and validation. Exactly one field should be tagged `primaryField`
+ * and at most one `secondaryField`.
+ *
+ * @public
+ */
+export declare function CustomFields(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+
+/**
+ * Marks a class as a custom object type.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which extracts metadata
+ * and generates the necessary platform registration code.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the class: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName installment_plan` and `@displayName Installment plan`,
+ * then apply the bare decorator `@CustomObject`.
+ *
+ * @public
+ */
+export declare function CustomObject(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+
+/* Excluded from this release type: _CustomObjectConstructor */
+
+/* Excluded from this release type: _executeMethod */
+
+/* Excluded from this release type: _ExecuteMethodOptions */
+
+/* Excluded from this release type: _ExecuteMethodRequest */
+
+/* Excluded from this release type: _getProxyState */
+
+/* Excluded from this release type: _getRegisteredApiNames */
+
+/* Excluded from this release type: _getRegisteredClass */
+
+/* Excluded from this release type: _getSlatedUpdates */
+
+/* Excluded from this release type: _hasProxyState */
+
+/* Excluded from this release type: _INSTANCE_CONTEXT */
+
+/* Excluded from this release type: _InstanceContext */
+
+/**
+ * Context type that restricts decorator application to instance methods only.
+ * Uses `{ readonly static: false }` to make TypeScript reject `@Action` on static methods.
+ *
+ * @public
+ */
+export declare type InstanceMethodDecoratorContext = { readonly static: false } & ClassMethodDecoratorContext;
+
+/* Excluded from this release type: _InvokeBeginEvent */
+
+/* Excluded from this release type: _InvokeCompleteEvent */
+
+/* Excluded from this release type: _InvokeErrorEvent */
+
+/* Excluded from this release type: _isTrackedField */
+
+/* Excluded from this release type: _persistObject */
+
+/* Excluded from this release type: _PersistOptions */
+
+/* Excluded from this release type: _PlatformMetadata */
+
+/* Excluded from this release type: _ProxiedObject */
+
+/* Excluded from this release type: _PROXY_STATE */
+
+/* Excluded from this release type: _ProxySetEvent */
+
+/* Excluded from this release type: _ProxyState */
+
+/* Excluded from this release type: _registerClass */
+
+/* Excluded from this release type: _RuntimeEvent */
+
+/* Excluded from this release type: _RuntimeEventEmitter */
+
+/* Excluded from this release type: _SaveBeginEvent */
+
+/* Excluded from this release type: _SaveCompleteEvent */
+
+/* Excluded from this release type: _SaveHandler */
+
+/**
+ * Result returned from save operations.
+ *
+ * @public
+ */
+export declare interface SaveResult {
+    /** Number of fields updated */
+    updatedFieldCount: number;
+}
+
+/* Excluded from this release type: _SpanBeginEvent */
+
+/* Excluded from this release type: _SpanEndEvent */
+
+/* Excluded from this release type: _SpanErrorEvent */
+
+/* Excluded from this release type: _UNTRACKED_FIELDS */
+
+/* Excluded from this release type: _UpdateFrame */
+
+export { }

package/dist/extensibility-custom-objects-beta.d.ts

@@ -0,0 +1,245 @@
+/**
+ * Stripe Custom Objects SDK
+ *
+ * Provides decorators and runtime support for defining custom object types
+ * that integrate with the Stripe platform. Custom objects are defined using
+ * TypeScript classes with decorators, then transformed at build time using
+ * `@stripe/extensibility-custom-objects-tools`.
+ *
+ * @packageDocumentation
+ */
+
+/* Excluded from this release type: __hasPendingChanges */
+
+/* Excluded from this release type: __queueSave */
+
+/**
+ * Marks an instance method as an action on a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the method in any way.
+ * It serves as a marker for the build-time transformer, which extracts action metadata
+ * and generates the necessary platform registration code.
+ *
+ * Can only be applied to instance methods, not static methods. Applying `@Action`
+ * to a static method is a TypeScript compile error.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the method: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName mark_delivered` and `@displayName Mark Delivered`,
+ * then apply the bare decorator `@Action`.
+ *
+ * @public
+ */
+export declare function Action(_target: (...args: never) => unknown, _context: InstanceMethodDecoratorContext): void;
+
+/* Excluded from this release type: _ActionMetadata */
+
+/* Excluded from this release type: _assemblePayload */
+
+/**
+ * Abstract base class for all custom objects.
+ *
+ * Provides built-in platform fields (id, object, created, updated, livemode)
+ * and a typed `fields` container for user-defined fields. The generic parameter
+ * `T` describes the shape of user fields accessible via `this.fields`.
+ *
+ * @remarks
+ * **Definite assignment assertions (`!`)**: All platform fields (`id`, `object`,
+ * `created`, `updated`, `livemode`, `fields`) use the TypeScript definite assignment
+ * assertion operator. This suppresses the "property has no initializer" error because
+ * these fields are intentionally left unset by the zero-argument constructor.
+ *
+ * The runtime (`executeInstanceMethod` in `invoke.ts`) is solely responsible for
+ * populating these fields via `Object.assign` and `hydrateInstance` **before** the
+ * dirty-tracking proxy is installed. Code that constructs a subclass directly
+ * (bypassing the runtime) will have `undefined` values for all platform fields at
+ * runtime, despite the types suggesting otherwise.
+ *
+ * @typeParam T - Shape of user-defined fields stored in `fields`
+ * @public
+ */
+export declare abstract class BaseObject<T extends Record<string, unknown> = Record<string, unknown>> {
+    /** Unique identifier assigned by the platform */
+    readonly id: string;
+    /** Object type identifier assigned by the platform */
+    readonly object: string;
+    /** Timestamp when the object was created */
+    readonly created: Date;
+    /** Timestamp when the object was last updated */
+    readonly updated: Date;
+    /** Whether the object exists in live mode (true) or test mode (false). @public */
+    readonly livemode: boolean;
+    /**
+     * User-defined fields container. Populated during hydration via Object.assign
+     * before the dirty-tracking proxy is installed.
+     * Access individual fields as `this.fields.fieldName`.
+     *
+     * @remarks
+     * The generic type `T` describes the shape of available fields after
+     * hydration, not at construction time. Fields may be undefined before
+     * the instance is hydrated with data from the platform.
+     *
+     * @public
+     */
+    readonly fields: T;
+    /**
+     * Flushes pending field mutations into the slated-updates accumulator.
+     *
+     * When called from a transformed action (no save handler configured), this
+     * records which fields were mutated so that the Logic wrapper can include them
+     * in the response envelope's `updatedFields`. No network call is made.
+     *
+     * When a save handler is configured (runtime invoke path), the handler is
+     * called for actual persistence and its result is returned.
+     *
+     * @returns The save result including `updatedFieldCount` (unique fields flushed)
+     * @throws Error if the object is not proxied
+     * @public
+     */
+    save(): Promise<SaveResult>;
+    /**
+     * Discard all pending changes and restore field values to their
+     * last-saved state. Has no effect if the object is not proxied.
+     *
+     * @public
+     */
+    revert(): void;
+}
+
+/* Excluded from this release type: _buildMethodResponse */
+
+/* Excluded from this release type: _clearRegistry */
+
+/* Excluded from this release type: _clearSlatedUpdates */
+
+/* Excluded from this release type: _commitProxyState */
+
+/* Excluded from this release type: _createEventEmitter */
+
+/* Excluded from this release type: _createInstanceProxy */
+
+/* Excluded from this release type: _CreateProxyOptions */
+
+/**
+ * Marks a class as a custom fields container for a custom object.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which discovers the fields
+ * class by this decorator and extracts field metadata from its members.
+ *
+ * The fields class must contain only field declarations (no methods). Use
+ * TSDoc tags from `@stripe/extensibility-jsonschema` on each field to control
+ * display and validation. Exactly one field should be tagged `primaryField`
+ * and at most one `secondaryField`.
+ *
+ * @public
+ */
+export declare function CustomFields(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+
+/**
+ * Marks a class as a custom object type.
+ *
+ * This decorator is **inert at runtime** — it does not modify the class in any way.
+ * It serves as a marker for the build-time transformer, which extracts metadata
+ * and generates the necessary platform registration code.
+ *
+ * All naming metadata is expressed via TSDoc annotation tags in a JSDoc comment
+ * on the class: `@apiName`, `@displayName`, `@description`.
+ *
+ * @example
+ * Use TSDoc tags in a JSDoc comment above the decorator,
+ * e.g. `@apiName installment_plan` and `@displayName Installment plan`,
+ * then apply the bare decorator `@CustomObject`.
+ *
+ * @public
+ */
+export declare function CustomObject(_target: new (...args: unknown[]) => unknown, _context: ClassDecoratorContext): void;
+
+/* Excluded from this release type: _CustomObjectConstructor */
+
+/* Excluded from this release type: _executeMethod */
+
+/* Excluded from this release type: _ExecuteMethodOptions */
+
+/* Excluded from this release type: _ExecuteMethodRequest */
+
+/* Excluded from this release type: _getProxyState */
+
+/* Excluded from this release type: _getRegisteredApiNames */
+
+/* Excluded from this release type: _getRegisteredClass */
+
+/* Excluded from this release type: _getSlatedUpdates */
+
+/* Excluded from this release type: _hasProxyState */
+
+/* Excluded from this release type: _INSTANCE_CONTEXT */
+
+/* Excluded from this release type: _InstanceContext */
+
+/**
+ * Context type that restricts decorator application to instance methods only.
+ * Uses `{ readonly static: false }` to make TypeScript reject `@Action` on static methods.
+ *
+ * @public
+ */
+export declare type InstanceMethodDecoratorContext = { readonly static: false } & ClassMethodDecoratorContext;
+
+/* Excluded from this release type: _InvokeBeginEvent */
+
+/* Excluded from this release type: _InvokeCompleteEvent */
+
+/* Excluded from this release type: _InvokeErrorEvent */
+
+/* Excluded from this release type: _isTrackedField */
+
+/* Excluded from this release type: _persistObject */
+
+/* Excluded from this release type: _PersistOptions */
+
+/* Excluded from this release type: _PlatformMetadata */
+
+/* Excluded from this release type: _ProxiedObject */
+
+/* Excluded from this release type: _PROXY_STATE */
+
+/* Excluded from this release type: _ProxySetEvent */
+
+/* Excluded from this release type: _ProxyState */
+
+/* Excluded from this release type: _registerClass */
+
+/* Excluded from this release type: _RuntimeEvent */
+
+/* Excluded from this release type: _RuntimeEventEmitter */
+
+/* Excluded from this release type: _SaveBeginEvent */
+
+/* Excluded from this release type: _SaveCompleteEvent */
+
+/* Excluded from this release type: _SaveHandler */
+
+/**
+ * Result returned from save operations.
+ *
+ * @public
+ */
+export declare interface SaveResult {
+    /** Number of fields updated */
+    updatedFieldCount: number;
+}
+
+/* Excluded from this release type: _SpanBeginEvent */
+
+/* Excluded from this release type: _SpanEndEvent */
+
+/* Excluded from this release type: _SpanErrorEvent */
+
+/* Excluded from this release type: _UNTRACKED_FIELDS */
+
+/* Excluded from this release type: _UpdateFrame */
+
+export { }