@dbx-tools/shared-appkit 0.0.0-stage → 0.9.188

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @dbx-tools/shared-appkit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Browser-safe schemas, route constants, and client configuration contracts for
+dbx-tools AppKit extensions.
+
+## Build a browser debug capture request
+
+`@dbx-tools/appkit` publishes the optional debug-capture plugin configuration,
+and `@dbx-tools/ui/react` consumes these contracts to record browser events.
+Applications normally enable the route through `createApp({ debug: "auto" })`,
+which is active only when `NODE_ENV=development`.
+
+```ts
+import {
+  DebugCaptureClientConfigSchema,
+  DebugCaptureRequestSchema,
+  debugCaptureRoute,
+} from "@dbx-tools/shared-appkit/debug";
+```
+
+Capture requests are bounded and contain scalar diagnostics only. The browser
+recorder does not send form values or printable key content.
+
+## Resolve the browser capture endpoint
+
+Use the published client configuration instead of hard-coding an AppKit route.
+The route helper normalizes a configured base path and appends the capture
+resource path.
+
+```ts
+import {
+  DebugCaptureClientConfigSchema,
+  debugCaptureRoute,
+} from "@dbx-tools/shared-appkit/debug";
+
+const config = DebugCaptureClientConfigSchema.parse({
+  basePath: "/api/debug-capture",
+});
+const endpoint = debugCaptureRoute(config.basePath);
+```
+
+The resulting endpoint is `/api/debug-capture/captures` for the default AppKit
+plugin configuration.
+
+## Validate debug requests
+
+Use `DebugCaptureRequestSchema` on route handlers or tests that accept browser
+debug payloads. The schema keeps the wire contract browser-safe while the node
+package owns persistence and any server-side processing.

package/index.debug.ts

@@ -0,0 +1,7 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+
+export * as contracts from "./src/debug/contracts.ts";
+export { DEBUG_CAPTURE_PLUGIN_NAME, DEBUG_CAPTURE_ROUTE, DEBUG_CAPTURE_DEFAULT_BASE_PATH, debugCaptureRoute, DebugCaptureScalarSchema, DebugCaptureEventSchema, DebugCaptureEventsSchema, DebugCaptureIdSchema, DebugCaptureRequestSchema, DebugCaptureStartResponseSchema, DebugCaptureAppendResponseSchema, DebugCaptureStopResponseSchema, DebugCaptureClientConfigSchema } from "./src/debug/contracts.ts";
+export type { DebugCaptureScalar, DebugCaptureEvent, DebugCaptureRequest, DebugCaptureClientConfig } from "./src/debug/contracts.ts";

package/index.ts

@@ -0,0 +1,6 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+
+export const PACKAGE_IDENTIFIER = "@dbx-tools/shared-appkit";
+export const PACKAGE_VERSION = "0.9.188";

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export declare const PACKAGE_IDENTIFIER = "@dbx-tools/shared-appkit";
+export declare const PACKAGE_VERSION = "0.9.188";

package/lib/index.debug.d.ts

@@ -0,0 +1,3 @@
+export * as contracts from "./src/debug/contracts.ts";
+export { DEBUG_CAPTURE_PLUGIN_NAME, DEBUG_CAPTURE_ROUTE, DEBUG_CAPTURE_DEFAULT_BASE_PATH, debugCaptureRoute, DebugCaptureScalarSchema, DebugCaptureEventSchema, DebugCaptureEventsSchema, DebugCaptureIdSchema, DebugCaptureRequestSchema, DebugCaptureStartResponseSchema, DebugCaptureAppendResponseSchema, DebugCaptureStopResponseSchema, DebugCaptureClientConfigSchema } from "./src/debug/contracts.ts";
+export type { DebugCaptureScalar, DebugCaptureEvent, DebugCaptureRequest, DebugCaptureClientConfig } from "./src/debug/contracts.ts";

package/lib/index.debug.js

@@ -0,0 +1,6 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+export * as contracts from "./src/debug/contracts.js";
+export { DEBUG_CAPTURE_PLUGIN_NAME, DEBUG_CAPTURE_ROUTE, DEBUG_CAPTURE_DEFAULT_BASE_PATH, debugCaptureRoute, DebugCaptureScalarSchema, DebugCaptureEventSchema, DebugCaptureEventsSchema, DebugCaptureIdSchema, DebugCaptureRequestSchema, DebugCaptureStartResponseSchema, DebugCaptureAppendResponseSchema, DebugCaptureStopResponseSchema, DebugCaptureClientConfigSchema } from "./src/debug/contracts.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZGVidWcuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC5kZWJ1Zy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssU0FBUyxNQUFNLDBCQUEwQixDQUFDO0FBQ3RELE9BQU8sRUFBRSx5QkFBeUIsRUFBRSxtQkFBbUIsRUFBRSwrQkFBK0IsRUFBRSxpQkFBaUIsRUFBRSx3QkFBd0IsRUFBRSx1QkFBdUIsRUFBRSx3QkFBd0IsRUFBRSxvQkFBb0IsRUFBRSx5QkFBeUIsRUFBRSwrQkFBK0IsRUFBRSxnQ0FBZ0MsRUFBRSw4QkFBOEIsRUFBRSw4QkFBOEIsRUFBRSxNQUFNLDBCQUEwQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0ICogYXMgY29udHJhY3RzIGZyb20gXCIuL3NyYy9kZWJ1Zy9jb250cmFjdHMudHNcIjtcbmV4cG9ydCB7IERFQlVHX0NBUFRVUkVfUExVR0lOX05BTUUsIERFQlVHX0NBUFRVUkVfUk9VVEUsIERFQlVHX0NBUFRVUkVfREVGQVVMVF9CQVNFX1BBVEgsIGRlYnVnQ2FwdHVyZVJvdXRlLCBEZWJ1Z0NhcHR1cmVTY2FsYXJTY2hlbWEsIERlYnVnQ2FwdHVyZUV2ZW50U2NoZW1hLCBEZWJ1Z0NhcHR1cmVFdmVudHNTY2hlbWEsIERlYnVnQ2FwdHVyZUlkU2NoZW1hLCBEZWJ1Z0NhcHR1cmVSZXF1ZXN0U2NoZW1hLCBEZWJ1Z0NhcHR1cmVTdGFydFJlc3BvbnNlU2NoZW1hLCBEZWJ1Z0NhcHR1cmVBcHBlbmRSZXNwb25zZVNjaGVtYSwgRGVidWdDYXB0dXJlU3RvcFJlc3BvbnNlU2NoZW1hLCBEZWJ1Z0NhcHR1cmVDbGllbnRDb25maWdTY2hlbWEgfSBmcm9tIFwiLi9zcmMvZGVidWcvY29udHJhY3RzLnRzXCI7XG5leHBvcnQgdHlwZSB7IERlYnVnQ2FwdHVyZVNjYWxhciwgRGVidWdDYXB0dXJlRXZlbnQsIERlYnVnQ2FwdHVyZVJlcXVlc3QsIERlYnVnQ2FwdHVyZUNsaWVudENvbmZpZyB9IGZyb20gXCIuL3NyYy9kZWJ1Zy9jb250cmFjdHMudHNcIjtcbiJdfQ==

package/lib/index.js

@@ -0,0 +1,6 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+export const PACKAGE_IDENTIFIER = "@dbx-tools/shared-appkit";
+export const PACKAGE_VERSION = "0.9.188";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRywwQkFBMEIsQ0FBQztBQUM3RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfSURFTlRJRklFUiA9IFwiQGRieC10b29scy9zaGFyZWQtYXBwa2l0XCI7XG5leHBvcnQgY29uc3QgUEFDS0FHRV9WRVJTSU9OID0gXCIwLjkuMTg4XCI7XG4iXX0=

package/lib/src/debug/contracts.d.ts

@@ -0,0 +1,75 @@
+import { z } from "zod";
+/** Registered AppKit plugin name for browser debug capture. */
+export declare const DEBUG_CAPTURE_PLUGIN_NAME = "debugCapture";
+/** Route segment registered beneath the debug-capture plugin base path. */
+export declare const DEBUG_CAPTURE_ROUTE = "/captures";
+/** Default AppKit mount for the debug-capture plugin. */
+export declare const DEBUG_CAPTURE_DEFAULT_BASE_PATH = "/api/debug-capture";
+/** Build the browser debug-capture endpoint from a published plugin base path. */
+export declare function debugCaptureRoute(basePath?: string): string;
+/** Scalar value allowed in debug capture metadata and event snapshots. */
+export declare const DebugCaptureScalarSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+/** Scalar value allowed in debug capture metadata and event snapshots. */
+export type DebugCaptureScalar = z.infer<typeof DebugCaptureScalarSchema>;
+/** One timestamped browser diagnostic event. */
+export declare const DebugCaptureEventSchema: z.ZodObject<{
+    at: z.ZodNumber;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    sequence: z.ZodNumber;
+    type: z.ZodString;
+}, z.core.$strict>;
+/** One timestamped browser diagnostic event. */
+export type DebugCaptureEvent = z.infer<typeof DebugCaptureEventSchema>;
+/** Bounded event batch accepted by append and stop requests. */
+export declare const DebugCaptureEventsSchema: z.ZodArray<z.ZodObject<{
+    at: z.ZodNumber;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    sequence: z.ZodNumber;
+    type: z.ZodString;
+}, z.core.$strict>>;
+/** Capture identifier generated by the AppKit debug plugin. */
+export declare const DebugCaptureIdSchema: z.ZodString;
+/** Request body accepted by the debug-capture route. */
+export declare const DebugCaptureRequestSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    action: z.ZodLiteral<"start">;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+}, z.core.$strict>, z.ZodObject<{
+    action: z.ZodLiteral<"append">;
+    captureId: z.ZodString;
+    events: z.ZodArray<z.ZodObject<{
+        at: z.ZodNumber;
+        data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+        sequence: z.ZodNumber;
+        type: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+    action: z.ZodLiteral<"stop">;
+    captureId: z.ZodString;
+    events: z.ZodArray<z.ZodObject<{
+        at: z.ZodNumber;
+        data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+        sequence: z.ZodNumber;
+        type: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>], "action">;
+/** Request body accepted by the debug-capture route. */
+export type DebugCaptureRequest = z.infer<typeof DebugCaptureRequestSchema>;
+/** Response returned after starting a browser debug capture. */
+export declare const DebugCaptureStartResponseSchema: z.ZodObject<{
+    captureId: z.ZodString;
+}, z.core.$strict>;
+/** Response returned after appending browser debug events. */
+export declare const DebugCaptureAppendResponseSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+}, z.core.$strict>;
+/** Response returned after stopping a browser debug capture. */
+export declare const DebugCaptureStopResponseSchema: z.ZodObject<{
+    captureId: z.ZodString;
+    ok: z.ZodLiteral<true>;
+}, z.core.$strict>;
+/** Browser-safe configuration published by the AppKit debug-capture plugin. */
+export declare const DebugCaptureClientConfigSchema: z.ZodObject<{
+    basePath: z.ZodString;
+}, z.core.$strict>;
+/** Browser-safe configuration published by the AppKit debug-capture plugin. */
+export type DebugCaptureClientConfig = z.infer<typeof DebugCaptureClientConfigSchema>;

package/lib/src/debug/contracts.js

@@ -0,0 +1,99 @@
+import { z } from "zod";
+/** Registered AppKit plugin name for browser debug capture. */
+export const DEBUG_CAPTURE_PLUGIN_NAME = "debugCapture";
+/** Route segment registered beneath the debug-capture plugin base path. */
+export const DEBUG_CAPTURE_ROUTE = "/captures";
+/** Default AppKit mount for the debug-capture plugin. */
+export const DEBUG_CAPTURE_DEFAULT_BASE_PATH = "/api/debug-capture";
+/** Build the browser debug-capture endpoint from a published plugin base path. */
+export function debugCaptureRoute(basePath = DEBUG_CAPTURE_DEFAULT_BASE_PATH) {
+    return `${basePath.replace(/\/+$/, "")}${DEBUG_CAPTURE_ROUTE}`;
+}
+/** Scalar value allowed in debug capture metadata and event snapshots. */
+export const DebugCaptureScalarSchema = z
+    .union([z.string().max(500), z.number().finite(), z.boolean(), z.null()])
+    .describe("Bounded scalar diagnostic value safe to serialize as JSON.");
+/** One timestamped browser diagnostic event. */
+export const DebugCaptureEventSchema = z
+    .object({
+    at: z
+        .number()
+        .finite()
+        .nonnegative()
+        .describe("Milliseconds elapsed since this capture started."),
+    data: z
+        .record(z.string().max(80), DebugCaptureScalarSchema)
+        .optional()
+        .describe("Browser, viewport, target, and selected element measurements."),
+    sequence: z.number().int().nonnegative().describe("Monotonic event sequence number."),
+    type: z.string().min(1).max(80).describe("Normalized browser or recorder event name."),
+})
+    .strict()
+    .describe("One browser debug-capture event.");
+/** Bounded event batch accepted by append and stop requests. */
+export const DebugCaptureEventsSchema = z
+    .array(DebugCaptureEventSchema)
+    .max(200)
+    .describe("Ordered browser diagnostic events uploaded in one request.");
+/** Capture identifier generated by the AppKit debug plugin. */
+export const DebugCaptureIdSchema = z
+    .string()
+    .regex(/^vp-[a-z0-9]+-[a-f0-9]{8}$/)
+    .describe("Opaque browser debug-capture identifier.");
+/** Request body accepted by the debug-capture route. */
+export const DebugCaptureRequestSchema = z
+    .discriminatedUnion("action", [
+    z
+        .object({
+        action: z.literal("start").describe("Start a new capture."),
+        metadata: z
+            .record(z.string().max(80), DebugCaptureScalarSchema)
+            .describe("Initial application, route, device, and browser metadata."),
+    })
+        .strict(),
+    z
+        .object({
+        action: z.literal("append").describe("Append buffered events."),
+        captureId: DebugCaptureIdSchema,
+        events: DebugCaptureEventsSchema,
+    })
+        .strict(),
+    z
+        .object({
+        action: z.literal("stop").describe("Append final events and close the capture."),
+        captureId: DebugCaptureIdSchema,
+        events: DebugCaptureEventsSchema,
+    })
+        .strict(),
+])
+    .describe("Start, append, or stop request for a browser debug capture.");
+/** Response returned after starting a browser debug capture. */
+export const DebugCaptureStartResponseSchema = z
+    .object({
+    captureId: DebugCaptureIdSchema,
+})
+    .strict()
+    .describe("New browser debug-capture identifier.");
+/** Response returned after appending browser debug events. */
+export const DebugCaptureAppendResponseSchema = z
+    .object({
+    ok: z.literal(true).describe("Whether the event batch was persisted."),
+})
+    .strict()
+    .describe("Browser debug-capture append result.");
+/** Response returned after stopping a browser debug capture. */
+export const DebugCaptureStopResponseSchema = z
+    .object({
+    captureId: DebugCaptureIdSchema,
+    ok: z.literal(true).describe("Whether the capture was closed."),
+})
+    .strict()
+    .describe("Completed browser debug-capture result.");
+/** Browser-safe configuration published by the AppKit debug-capture plugin. */
+export const DebugCaptureClientConfigSchema = z
+    .object({
+    basePath: z.string().min(1).describe("AppKit mount containing the capture route."),
+})
+    .strict()
+    .describe("Browser-safe AppKit debug-capture configuration.");
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../src/debug/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,+DAA+D;AAC/D,MAAM,CAAC,MAAM,yBAAyB,GAAG,cAAc,CAAC;AAExD,2EAA2E;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC;AAE/C,yDAAyD;AACzD,MAAM,CAAC,MAAM,+BAA+B,GAAG,oBAAoB,CAAC;AAEpE,kFAAkF;AAClF,MAAM,UAAU,iBAAiB,CAAC,QAAQ,GAAG,+BAA+B;IAC1E,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,mBAAmB,EAAE,CAAC;AACjE,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KACxE,QAAQ,CAAC,4DAA4D,CAAC,CAAC;AAK1E,gDAAgD;AAChD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC;IACN,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,MAAM,EAAE;SACR,WAAW,EAAE;SACb,QAAQ,CAAC,kDAAkD,CAAC;IAC/D,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC;SACpD,QAAQ,EAAE;SACV,QAAQ,CAAC,+DAA+D,CAAC;IAC5E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACrF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC;CACvF,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,kCAAkC,CAAC,CAAC;AAKhD,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC,uBAAuB,CAAC;KAC9B,GAAG,CAAC,GAAG,CAAC;KACR,QAAQ,CAAC,4DAA4D,CAAC,CAAC;AAE1E,+DAA+D;AAC/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,EAAE;KACR,KAAK,CAAC,4BAA4B,CAAC;KACnC,QAAQ,CAAC,0CAA0C,CAAC,CAAC;AAExD,wDAAwD;AACxD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,kBAAkB,CAAC,QAAQ,EAAE;IAC5B,CAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QAC3D,QAAQ,EAAE,CAAC;aACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC;aACpD,QAAQ,CAAC,2DAA2D,CAAC;KACzE,CAAC;SACD,MAAM,EAAE;IACX,CAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QAC/D,SAAS,EAAE,oBAAoB;QAC/B,MAAM,EAAE,wBAAwB;KACjC,CAAC;SACD,MAAM,EAAE;IACX,CAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC;QAChF,SAAS,EAAE,oBAAoB;QAC/B,MAAM,EAAE,wBAAwB;KACjC,CAAC;SACD,MAAM,EAAE;CACZ,CAAC;KACD,QAAQ,CAAC,6DAA6D,CAAC,CAAC;AAK3E,gEAAgE;AAChE,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,SAAS,EAAE,oBAAoB;CAChC,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,uCAAuC,CAAC,CAAC;AAErD,8DAA8D;AAC9D,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC;KAC9C,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,wCAAwC,CAAC;CACvE,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,sCAAsC,CAAC,CAAC;AAEpD,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,SAAS,EAAE,oBAAoB;IAC/B,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;CAChE,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,yCAAyC,CAAC,CAAC;AAEvD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC;CACnF,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,kDAAkD,CAAC,CAAC","sourcesContent":["import { z } from \"zod\";\n\n/** Registered AppKit plugin name for browser debug capture. */\nexport const DEBUG_CAPTURE_PLUGIN_NAME = \"debugCapture\";\n\n/** Route segment registered beneath the debug-capture plugin base path. */\nexport const DEBUG_CAPTURE_ROUTE = \"/captures\";\n\n/** Default AppKit mount for the debug-capture plugin. */\nexport const DEBUG_CAPTURE_DEFAULT_BASE_PATH = \"/api/debug-capture\";\n\n/** Build the browser debug-capture endpoint from a published plugin base path. */\nexport function debugCaptureRoute(basePath = DEBUG_CAPTURE_DEFAULT_BASE_PATH): string {\n  return `${basePath.replace(/\\/+$/, \"\")}${DEBUG_CAPTURE_ROUTE}`;\n}\n\n/** Scalar value allowed in debug capture metadata and event snapshots. */\nexport const DebugCaptureScalarSchema = z\n  .union([z.string().max(500), z.number().finite(), z.boolean(), z.null()])\n  .describe(\"Bounded scalar diagnostic value safe to serialize as JSON.\");\n\n/** Scalar value allowed in debug capture metadata and event snapshots. */\nexport type DebugCaptureScalar = z.infer<typeof DebugCaptureScalarSchema>;\n\n/** One timestamped browser diagnostic event. */\nexport const DebugCaptureEventSchema = z\n  .object({\n    at: z\n      .number()\n      .finite()\n      .nonnegative()\n      .describe(\"Milliseconds elapsed since this capture started.\"),\n    data: z\n      .record(z.string().max(80), DebugCaptureScalarSchema)\n      .optional()\n      .describe(\"Browser, viewport, target, and selected element measurements.\"),\n    sequence: z.number().int().nonnegative().describe(\"Monotonic event sequence number.\"),\n    type: z.string().min(1).max(80).describe(\"Normalized browser or recorder event name.\"),\n  })\n  .strict()\n  .describe(\"One browser debug-capture event.\");\n\n/** One timestamped browser diagnostic event. */\nexport type DebugCaptureEvent = z.infer<typeof DebugCaptureEventSchema>;\n\n/** Bounded event batch accepted by append and stop requests. */\nexport const DebugCaptureEventsSchema = z\n  .array(DebugCaptureEventSchema)\n  .max(200)\n  .describe(\"Ordered browser diagnostic events uploaded in one request.\");\n\n/** Capture identifier generated by the AppKit debug plugin. */\nexport const DebugCaptureIdSchema = z\n  .string()\n  .regex(/^vp-[a-z0-9]+-[a-f0-9]{8}$/)\n  .describe(\"Opaque browser debug-capture identifier.\");\n\n/** Request body accepted by the debug-capture route. */\nexport const DebugCaptureRequestSchema = z\n  .discriminatedUnion(\"action\", [\n    z\n      .object({\n        action: z.literal(\"start\").describe(\"Start a new capture.\"),\n        metadata: z\n          .record(z.string().max(80), DebugCaptureScalarSchema)\n          .describe(\"Initial application, route, device, and browser metadata.\"),\n      })\n      .strict(),\n    z\n      .object({\n        action: z.literal(\"append\").describe(\"Append buffered events.\"),\n        captureId: DebugCaptureIdSchema,\n        events: DebugCaptureEventsSchema,\n      })\n      .strict(),\n    z\n      .object({\n        action: z.literal(\"stop\").describe(\"Append final events and close the capture.\"),\n        captureId: DebugCaptureIdSchema,\n        events: DebugCaptureEventsSchema,\n      })\n      .strict(),\n  ])\n  .describe(\"Start, append, or stop request for a browser debug capture.\");\n\n/** Request body accepted by the debug-capture route. */\nexport type DebugCaptureRequest = z.infer<typeof DebugCaptureRequestSchema>;\n\n/** Response returned after starting a browser debug capture. */\nexport const DebugCaptureStartResponseSchema = z\n  .object({\n    captureId: DebugCaptureIdSchema,\n  })\n  .strict()\n  .describe(\"New browser debug-capture identifier.\");\n\n/** Response returned after appending browser debug events. */\nexport const DebugCaptureAppendResponseSchema = z\n  .object({\n    ok: z.literal(true).describe(\"Whether the event batch was persisted.\"),\n  })\n  .strict()\n  .describe(\"Browser debug-capture append result.\");\n\n/** Response returned after stopping a browser debug capture. */\nexport const DebugCaptureStopResponseSchema = z\n  .object({\n    captureId: DebugCaptureIdSchema,\n    ok: z.literal(true).describe(\"Whether the capture was closed.\"),\n  })\n  .strict()\n  .describe(\"Completed browser debug-capture result.\");\n\n/** Browser-safe configuration published by the AppKit debug-capture plugin. */\nexport const DebugCaptureClientConfigSchema = z\n  .object({\n    basePath: z.string().min(1).describe(\"AppKit mount containing the capture route.\"),\n  })\n  .strict()\n  .describe(\"Browser-safe AppKit debug-capture configuration.\");\n\n/** Browser-safe configuration published by the AppKit debug-capture plugin. */\nexport type DebugCaptureClientConfig = z.infer<typeof DebugCaptureClientConfigSchema>;\n"]}

package/lib/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/debug/contracts.ts","../index.debug.ts","../index.ts"],"version":"5.9.3"}

package/package.json

@@ -1,6 +1,70 @@
 {
   "name": "@dbx-tools/shared-appkit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "Browser-safe contracts for dbx-tools AppKit plugins and development diagnostics",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/reggie-db/dbx-tools.git",
+    "directory": "packages/js/shared/appkit"
+  },
+  "scripts": {
+    "build": "projen build",
+    "compile": "projen compile",
+    "default": "projen default",
+    "package": "projen package",
+    "post-compile": "projen post-compile",
+    "pre-compile": "projen pre-compile",
+    "prepack": "projen prepack",
+    "test": "projen test",
+    "watch": "projen watch",
+    "projen": "projen"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "zod": "4.3.6"
+  },
+  "main": "./lib/index.js",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "./lib/index.js",
+    "types": "./lib/index.d.ts",
+    "exports": {
+      ".": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "./debug": {
+        "types": "./lib/index.debug.d.ts",
+        "default": "./lib/index.debug.js"
+      },
+      "./package.json": "./package.json"
+    }
+  },
+  "version": "0.9.188",
+  "types": "./lib/index.d.ts",
+  "dbxToolsConfig": {
+    "tags": [
+      "shared"
+    ]
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./debug": {
+      "types": "./lib/index.debug.d.ts",
+      "default": "./lib/index.debug.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "index*.ts",
+    "src",
+    "lib"
+  ],
+  "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"bunx projen\"."
+}

package/src/debug/contracts.ts

@@ -0,0 +1,123 @@
+import { z } from "zod";
+
+/** Registered AppKit plugin name for browser debug capture. */
+export const DEBUG_CAPTURE_PLUGIN_NAME = "debugCapture";
+
+/** Route segment registered beneath the debug-capture plugin base path. */
+export const DEBUG_CAPTURE_ROUTE = "/captures";
+
+/** Default AppKit mount for the debug-capture plugin. */
+export const DEBUG_CAPTURE_DEFAULT_BASE_PATH = "/api/debug-capture";
+
+/** Build the browser debug-capture endpoint from a published plugin base path. */
+export function debugCaptureRoute(basePath = DEBUG_CAPTURE_DEFAULT_BASE_PATH): string {
+  return `${basePath.replace(/\/+$/, "")}${DEBUG_CAPTURE_ROUTE}`;
+}
+
+/** Scalar value allowed in debug capture metadata and event snapshots. */
+export const DebugCaptureScalarSchema = z
+  .union([z.string().max(500), z.number().finite(), z.boolean(), z.null()])
+  .describe("Bounded scalar diagnostic value safe to serialize as JSON.");
+
+/** Scalar value allowed in debug capture metadata and event snapshots. */
+export type DebugCaptureScalar = z.infer<typeof DebugCaptureScalarSchema>;
+
+/** One timestamped browser diagnostic event. */
+export const DebugCaptureEventSchema = z
+  .object({
+    at: z
+      .number()
+      .finite()
+      .nonnegative()
+      .describe("Milliseconds elapsed since this capture started."),
+    data: z
+      .record(z.string().max(80), DebugCaptureScalarSchema)
+      .optional()
+      .describe("Browser, viewport, target, and selected element measurements."),
+    sequence: z.number().int().nonnegative().describe("Monotonic event sequence number."),
+    type: z.string().min(1).max(80).describe("Normalized browser or recorder event name."),
+  })
+  .strict()
+  .describe("One browser debug-capture event.");
+
+/** One timestamped browser diagnostic event. */
+export type DebugCaptureEvent = z.infer<typeof DebugCaptureEventSchema>;
+
+/** Bounded event batch accepted by append and stop requests. */
+export const DebugCaptureEventsSchema = z
+  .array(DebugCaptureEventSchema)
+  .max(200)
+  .describe("Ordered browser diagnostic events uploaded in one request.");
+
+/** Capture identifier generated by the AppKit debug plugin. */
+export const DebugCaptureIdSchema = z
+  .string()
+  .regex(/^vp-[a-z0-9]+-[a-f0-9]{8}$/)
+  .describe("Opaque browser debug-capture identifier.");
+
+/** Request body accepted by the debug-capture route. */
+export const DebugCaptureRequestSchema = z
+  .discriminatedUnion("action", [
+    z
+      .object({
+        action: z.literal("start").describe("Start a new capture."),
+        metadata: z
+          .record(z.string().max(80), DebugCaptureScalarSchema)
+          .describe("Initial application, route, device, and browser metadata."),
+      })
+      .strict(),
+    z
+      .object({
+        action: z.literal("append").describe("Append buffered events."),
+        captureId: DebugCaptureIdSchema,
+        events: DebugCaptureEventsSchema,
+      })
+      .strict(),
+    z
+      .object({
+        action: z.literal("stop").describe("Append final events and close the capture."),
+        captureId: DebugCaptureIdSchema,
+        events: DebugCaptureEventsSchema,
+      })
+      .strict(),
+  ])
+  .describe("Start, append, or stop request for a browser debug capture.");
+
+/** Request body accepted by the debug-capture route. */
+export type DebugCaptureRequest = z.infer<typeof DebugCaptureRequestSchema>;
+
+/** Response returned after starting a browser debug capture. */
+export const DebugCaptureStartResponseSchema = z
+  .object({
+    captureId: DebugCaptureIdSchema,
+  })
+  .strict()
+  .describe("New browser debug-capture identifier.");
+
+/** Response returned after appending browser debug events. */
+export const DebugCaptureAppendResponseSchema = z
+  .object({
+    ok: z.literal(true).describe("Whether the event batch was persisted."),
+  })
+  .strict()
+  .describe("Browser debug-capture append result.");
+
+/** Response returned after stopping a browser debug capture. */
+export const DebugCaptureStopResponseSchema = z
+  .object({
+    captureId: DebugCaptureIdSchema,
+    ok: z.literal(true).describe("Whether the capture was closed."),
+  })
+  .strict()
+  .describe("Completed browser debug-capture result.");
+
+/** Browser-safe configuration published by the AppKit debug-capture plugin. */
+export const DebugCaptureClientConfigSchema = z
+  .object({
+    basePath: z.string().min(1).describe("AppKit mount containing the capture route."),
+  })
+  .strict()
+  .describe("Browser-safe AppKit debug-capture configuration.");
+
+/** Browser-safe configuration published by the AppKit debug-capture plugin. */
+export type DebugCaptureClientConfig = z.infer<typeof DebugCaptureClientConfigSchema>;