@vekil/app-sdk 0.4.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 2026 Vekil
+
+   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

@@ -0,0 +1,232 @@
+# Vekil App SDK
+
+Build Remote Apps that connect Vekil to APIs, services, and developer-operated
+workflows.
+
+`@vekil/app-sdk` provides the contracts and server helpers needed to:
+
+- describe what an App can understand and do;
+- validate typed inputs, outcomes, settings, and permissions;
+- receive and verify signed requests from Vekil;
+- plan and execute work in your own Runtime;
+- return structured results, artifacts, and interactive Bubbles;
+- test the complete App before publishing it.
+
+The package supports ESM, CommonJS, and TypeScript on Node.js 22 and newer.
+
+## Documentation
+
+| Guide                                                        | Use it for                                                                                |
+| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
+| [App Definition](./docs/app-definition.md)                   | Describe capabilities, intents, actions, settings, policies, artifacts, and listing copy. |
+| [Remote Runtime](./docs/runtime.md)                          | Implement handlers, provider authorization, replay protection, and production hosting.    |
+| [CLI reference](./docs/cli.md)                               | Create, validate, inspect, build, and prepare a Runtime project.                          |
+| [Security and versioning](./docs/security-and-versioning.md) | Protect credentials, verify requests, handle retries, and ship compatible updates.        |
+
+The exported TypeScript types and generated JSON Schema are the authoritative
+machine-readable contract.
+
+## Quick start
+
+Create a fail-closed Remote App starter:
+
+```bash
+pnpm dlx @vekil/app-sdk init my-app --name "My App"
+cd my-app
+pnpm install
+```
+
+The generated project contains:
+
+```text
+my-app/
+├── .env.example
+├── .gitignore
+├── package.json
+├── runtime.mjs
+└── vekil.app.mjs
+```
+
+The starter rejects planning and execution until its handlers are implemented.
+It also refuses to use the in-memory replay store in production.
+
+## Define what the App does
+
+Use `createRemoteAppStarterDefinition` for a small read-only starting point.
+Use `defineRemoteApp` for the complete contract surface.
+
+```js
+import { AppCategoryId, createRemoteAppStarterDefinition } from "@vekil/app-sdk";
+
+export default createRemoteAppStarterDefinition({
+  categoryId: AppCategoryId.PRODUCTIVITY,
+  exampleRequest: "Can you help me prepare this request?",
+  longDescription: "Explain when this App is useful and what result it provides.",
+  name: "My App",
+  publication: {
+    websiteUrl: "https://example.com",
+    privacyPolicyUrl: "https://example.com/privacy",
+    termsUrl: "https://example.com/terms"
+  },
+  runtime: {
+    baseUrl: "https://runtime.example.com",
+    jwksUrl: "https://runtime.example.com/.well-known/jwks.json"
+  },
+  shortDescription: "Describe the concrete work this App helps with."
+});
+```
+
+An App Definition contains only the behavior, configuration, public copy, and
+Runtime endpoints that you maintain. Your Builder profile supplies developer
+information when the App is imported.
+
+See [App Definition](./docs/app-definition.md) for the complete model.
+
+## Validate and build
+
+```bash
+pnpm validate
+pnpm conformance
+pnpm build
+```
+
+`build` writes:
+
+- `dist/definition.json`, ready to import into Builder;
+- `dist/app-definition.schema.json`, the matching JSON Schema.
+
+In Vekil, open **Apps -> Build your App -> Connect your service**, import
+`definition.json`, and prepare a test release. Builder validates the Definition
+again before testing the Runtime.
+
+## Configure the Runtime
+
+Download `vekil.manifest.json` from the prepared test release, place it beside
+the Runtime, and generate signing keys:
+
+```bash
+pnpm vekil-app keys ./vekil.manifest.json
+```
+
+Store the printed private key values in your secret manager. Expose only the
+public JWKS document through the URL declared in the Definition.
+
+Runtime helpers live in `@vekil/app-sdk/runtime`:
+
+```js
+import { createServer } from "node:http";
+import {
+  createAppRuntimeBindings,
+  createRemoteAppRuntime,
+  readAppRuntimeSigningIdentity
+} from "@vekil/app-sdk/runtime";
+import manifest from "./vekil.manifest.json" with { type: "json" };
+import { handlers } from "./src/handlers.js";
+import { replayStore } from "./src/replay-store.js";
+
+const signingIdentity = readAppRuntimeSigningIdentity({
+  manifest,
+  keyId: process.env.VEKIL_APP_SIGNING_KEY_ID,
+  privateJwkBase64url: process.env.VEKIL_APP_SIGNING_PRIVATE_JWK_BASE64URL
+});
+
+if (!signingIdentity || !process.env.VEKIL_PLATFORM_JWKS_URL) {
+  throw new Error("Runtime signing configuration is incomplete.");
+}
+
+export const bindings = createAppRuntimeBindings(manifest);
+
+const runtime = createRemoteAppRuntime({
+  handlers,
+  manifest,
+  platformJwksUrl: process.env.VEKIL_PLATFORM_JWKS_URL,
+  replayStore,
+  signingIdentity
+});
+
+createServer((request, response) => {
+  void runtime.handleNodeRequest(request, response);
+}).listen(Number(process.env.PORT ?? 4100));
+```
+
+`runtime.handle(request)` provides the equivalent Fetch API adapter.
+
+## Use local keys in business code
+
+Definitions use readable local keys such as `find-options` and
+`options-found`. Resolve them through the downloaded manifest:
+
+```js
+const action = bindings.actionId("find-options");
+const artifact = bindings.artifactId("option");
+const outcome = bindings.outcomeId("options-found");
+```
+
+Each resolver rejects a key that is not declared by the tested App release.
+
+## Read action input and artifacts
+
+Vekil may provide typed artifacts from earlier work under the reserved
+`$artifacts` envelope. Keep them separate from App-owned input:
+
+```js
+import { readAppActionInput, readAppContextArtifactInputs } from "@vekil/app-sdk";
+
+const input = actionInputSchema.parse(readAppActionInput(request.input));
+const artifacts = readAppContextArtifactInputs(request.input);
+```
+
+Do not parse the complete `request.input` with a strict App-owned schema or
+reinterpret reserved context fields.
+
+## Public entrypoints
+
+```ts
+import {
+  buildAppArtifacts,
+  createRemoteAppStarterDefinition,
+  defineRemoteApp,
+  runAppConformance
+} from "@vekil/app-sdk";
+
+import {
+  createAppRuntimeBindings,
+  createRemoteAppRuntime,
+  generateAppRuntimeKeyMaterial,
+  readAppRuntimeSigningIdentity
+} from "@vekil/app-sdk/runtime";
+```
+
+- `@vekil/app-sdk` contains authoring, App Context, Bubble, validation, and build
+  contracts.
+- `@vekil/app-sdk/runtime` contains server-only signing, request verification,
+  Runtime adapters, bindings, and replay-store interfaces.
+
+## Before production
+
+The Remote Runtime owns its provider integration, provider credentials,
+database, idempotency records, and operational logs. Before releasing it:
+
+- deploy every public endpoint over HTTPS;
+- replace the development replay store with an atomic durable implementation;
+- keep signing keys and provider credentials outside source control;
+- validate App-owned input before using it;
+- make every side effect idempotent;
+- honor timeouts, cancellation, and retryability;
+- return only declared outcomes, artifacts, and Bubbles;
+- run Builder's Runtime test against the exact deployed release.
+
+See [Remote Runtime](./docs/runtime.md) for the full production checklist.
+
+## Compatibility
+
+The SDK is pre-1.0. Pin a minor line such as `^0.4.0` to receive compatible
+`0.4.x` patches without crossing into `0.5.0`. Commit the package-manager
+lockfile and validate every SDK update before preparing a new App release.
+
+See [Security and versioning](./docs/security-and-versioning.md) for the support
+policy.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).