@qauth-labs/plugin-sdk 0.0.0 → 0.2.0-rc.2

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 2025 QAuth Labs
+
+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 +1,149 @@
 # @qauth-labs/plugin-sdk
+
+> **Experimental.** This package is QAuth's plugin API, the experimental item
+> [`plugin-api`](https://docs.qauth.dev/reference/experimental-features/#plugin-api).
+> It is public and documented, so you can write plugins against it, but it is
+> outside QAuth's 1.0 stability promise: it may change in a minor release,
+> without a deprecation window. It becomes stable in 1.x.
+
+Write, test and release a sign-in method for
+**[QAuth](https://github.com/qauth-labs/qauth)** in your own repository. A
+plugin is an npm package that exports one **AuthMethod**: a sign-in method that
+plugs into QAuth's engine, such as an upstream OAuth 2.0 or OpenID Connect
+provider. This package is the contract it is written against,
+`qauth-auth-method/1-rc.0`:
+
+- the `AuthMethod` interface and the types it uses: the context and the egress
+  client as a method sees them, and the `CredentialProvider` half it extends;
+- the contract's constants: `AUTH_METHOD_CONTRACT`, the plugin export
+  `AUTH_METHOD_PLUGIN_EXPORT`, the upstream step `UPSTREAM_STEP_URN`, the
+  patterns and the caps;
+- its errors, and the static checks QAuth's registry runs on a method;
+- the contract test kit, `checkAuthMethod`, under `@qauth-labs/plugin-sdk/testing`.
+
+The contract is documented at
+[docs.qauth.dev/extend/auth-method-contract](https://docs.qauth.dev/extend/auth-method-contract/).
+
+## Install
+
+```bash
+npm install @qauth-labs/plugin-sdk@0.2.0-rc.1 zod
+```
+
+Install the version of the QAuth release your plugin is for: the SDK carries
+QAuth's own version, and a server refuses a plugin written against another
+contract version ([Versions](#versions)). A release candidate is on npm's
+`next` dist-tag and a release on `latest`; until QAuth's first SDK release,
+`latest` holds only a deprecated `0.0.0` placeholder. `zod` is a peer dependency: a method's config schema is a Zod 4 schema, and the
+server reads it (its JSON Schema, its `writeOnly` marks) with its own copy.
+
+## Write the method
+
+The package exports its method as `authMethod`:
+
+```ts
+import { AUTH_METHOD_CONTRACT, type AuthMethod, UPSTREAM_STEP_URN } from '@qauth-labs/plugin-sdk';
+import { z } from 'zod';
+
+const configSchema = z.object({
+  clientId: z.string().min(1),
+  // A secret member: the server keeps it write-only and encrypted at rest.
+  clientSecret: z.string().min(1).meta({ writeOnly: true }),
+});
+
+export const authMethod: AuthMethod<z.output<typeof configSchema>, MyTransaction> = {
+  contract: AUTH_METHOD_CONTRACT,
+  type: 'corp_sso', // its route segment: /upstream/corp_sso/…
+  id: 'corp-sso', // the name the admin API gives the plugin
+  display: { name: 'Corp SSO' },
+  configSchema,
+  steps: [UPSTREAM_STEP_URN],
+  routes: [/* the callback the provider sends the browser back to */],
+  async start(request, context) {
+    /* where the browser goes */
+  },
+  async verify(result) {
+    /* only results of its own callback, once each */
+  },
+  extractAttributes(identity) {
+    /* attributes under its own type */
+  },
+};
+```
+
+A method is handed only its context: its config for the realm, the egress
+client (every outbound call goes through it, never `fetch`), the signer (for a
+client assertion; no key) and a logger. It never sees a database, a cookie or a
+request header.
+
+Some names are taken. A method's `type` may not be one QAuth writes itself
+(`RESERVED_AUTH_METHOD_TYPES`), which the kit checks. Its `type` may not start
+with `oidc_`, and its `id` may not be `oidc`: both belong to QAuth's generic
+OpenID Connect client. The kit, which checks that client too, lets those two
+pass, and the server refuses them at boot.
+
+[`examples/minimal-plugin`](./examples/minimal-plugin) is a complete method
+for an OAuth 2.0 provider with PKCE and a userinfo endpoint, with its test.
+
+## Test it with the kit
+
+```ts
+import { checkAuthMethod } from '@qauth-labs/plugin-sdk/testing';
+
+await checkAuthMethod(authMethod, {
+  config: { clientId: 'kit-client', clientSecret: 'kit-client-secret-0123' },
+  egress: (request) => fakeProvider.answer(request),
+  callback: (authorizationRequest) => fakeProvider.signIn(authorizationRequest),
+  declined: (authorizationRequest) => fakeProvider.decline(authorizationRequest),
+});
+```
+
+You play the provider. The kit runs the method the way the server does, with
+the server's own checks, and rejects with an `AuthMethodContractError` that
+lists every check the method failed: the static checks, a fresh transaction and
+binding for each start, the binding carried back, PKCE with S256, `verify()`
+refusing what its callback did not produce, no `fetch`, and no secret in a log
+line. It works in any test runner, and refuses to run with
+`NODE_ENV=production`, because it replaces the global `fetch` while it runs.
+
+## Publish it, and what the operator does
+
+Publish the package's compiled JavaScript (Node does not strip TypeScript types
+under `node_modules`). List `@qauth-labs/plugin-sdk` under `dependencies`: the
+contract's constants are part of your method at run time. List `zod` under
+`peerDependencies`, so the method's schema is built with the server's Zod. Then
+an operator:
+
+1. installs the package with the deployment, as any other dependency of the
+   auth server;
+2. lists it by package name in `AUTH_METHOD_PLUGINS`;
+3. turns on `PLUGIN_API_ENABLED=true`: a plugin outside QAuth's first-party list
+   loads only while it is on, and the boot says so when it is off;
+4. enables and configures it per realm through the admin API.
+
+A plugin is trusted code that runs in-process. The server imports a package
+only by its npm name, never a path or a URL.
+
+## Entry points
+
+| Entry point                      | What it holds                                                             |
+| -------------------------------- | ------------------------------------------------------------------------- |
+| `@qauth-labs/plugin-sdk`         | What a plugin imports: types, constants, errors, static checks.           |
+| `@qauth-labs/plugin-sdk/testing` | The contract test kit, for a plugin's own tests.                          |
+| `@qauth-labs/plugin-sdk/host`    | The host's half, which QAuth's server imports. A plugin does not need it. |
+
+[`api-report.md`](./api-report.md) lists every name each one exports.
+
+## Versions
+
+The package carries QAuth's own version, from QAuth's release tag: a release
+candidate `0.Y.Z-rc.N` is on the `next` dist-tag, a release on `latest`. The
+contract it implements has a version of its own, `AUTH_METHOD_CONTRACT_VERSION`
+(`1-rc.0`), a release candidate until QAuth 1.0.0. A breaking change to anything
+this package exports raises it, and a server refuses a plugin written against
+another version, so the boot fails instead of running a plugin against a
+contract it does not know.
+
+## License
+
+Apache-2.0

package/dist/host.d.ts

@@ -0,0 +1,24 @@
+/**
+ * `@qauth-labs/plugin-sdk/host` — the host's half of the AuthMethod contract
+ * (#599): what QAuth's server runs around a method, and what the contract
+ * test kit runs the same way, so a method meets in its tests exactly what the
+ * server does.
+ *
+ * - the engine's checks around the two calls it makes into a method
+ *   (`startUpstreamStep`, `completeUpstreamStep`) and the host's binding check
+ *   before it hands a callback its transaction (`presentedUpstreamBinding`,
+ *   `upstreamBindingMatches`);
+ * - the context a method is handed for one realm (`createAuthMethodContext`),
+ *   over the host's egress client, signer and logger;
+ * - the parameters a route handler sees (`authMethodParameters`);
+ * - the registry's snapshot and route checks.
+ *
+ * EXPERIMENTAL, like the contract. A plugin does not import this entry point:
+ * it needs only the main one and `@qauth-labs/plugin-sdk/testing`.
+ *
+ * @packageDocumentation
+ */
+export * from './lib/context.js';
+export * from './lib/engine.js';
+export { authMethodParameters } from './lib/parameters.js';
+export { authMethodSnapshot, authMethodTypeProblems, declaresAuthMethodContract, routeProblems, } from './lib/validate.js';

package/dist/host.js

@@ -0,0 +1,24 @@
+/**
+ * `@qauth-labs/plugin-sdk/host` — the host's half of the AuthMethod contract
+ * (#599): what QAuth's server runs around a method, and what the contract
+ * test kit runs the same way, so a method meets in its tests exactly what the
+ * server does.
+ *
+ * - the engine's checks around the two calls it makes into a method
+ *   (`startUpstreamStep`, `completeUpstreamStep`) and the host's binding check
+ *   before it hands a callback its transaction (`presentedUpstreamBinding`,
+ *   `upstreamBindingMatches`);
+ * - the context a method is handed for one realm (`createAuthMethodContext`),
+ *   over the host's egress client, signer and logger;
+ * - the parameters a route handler sees (`authMethodParameters`);
+ * - the registry's snapshot and route checks.
+ *
+ * EXPERIMENTAL, like the contract. A plugin does not import this entry point:
+ * it needs only the main one and `@qauth-labs/plugin-sdk/testing`.
+ *
+ * @packageDocumentation
+ */
+export * from './lib/context.js';
+export * from './lib/engine.js';
+export { authMethodParameters } from './lib/parameters.js';
+export { authMethodSnapshot, authMethodTypeProblems, declaresAuthMethodContract, routeProblems, } from './lib/validate.js';

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * `@qauth-labs/plugin-sdk` — what a QAuth sign-in method plugin is written
+ * against: the AuthMethod contract (`qauth-auth-method/1-rc.0`).
+ *
+ * EXPERIMENTAL. The contract is QAuth's plugin API, the experimental item
+ * `plugin-api` (ADR-018 §4): public and documented, but outside the 1.0
+ * stability promise, so it may change in a minor release. A breaking change to
+ * anything this package exports raises {@link AUTH_METHOD_CONTRACT_VERSION}, and
+ * the server refuses a plugin written against another version.
+ *
+ * Three entry points:
+ *
+ * - this one: the `AuthMethod` interface and the types it uses, the contract's
+ *   constants, its errors and the static checks the server's registry runs;
+ * - `@qauth-labs/plugin-sdk/testing`: the contract test kit,
+ *   `checkAuthMethod`, for a plugin's own tests;
+ * - `@qauth-labs/plugin-sdk/host`: the host's half, which QAuth's server
+ *   imports and the test kit runs (the engine's checks around a method's
+ *   answers, the context a method is handed). A plugin does not need it.
+ *
+ * See the package README and `examples/minimal-plugin`.
+ *
+ * @packageDocumentation
+ */
+export type * from './lib/auth-method.js';
+export type * from './lib/credential-provider.js';
+export * from './lib/contract.js';
+export { AuthMethodConfigError, AuthMethodContractError, AuthMethodFaultError, } from './lib/errors.js';
+export { assertAuthMethod, authMethodProblems, isAuthMethod } from './lib/validate.js';

package/dist/index.js

@@ -0,0 +1,31 @@
+/**
+ * `@qauth-labs/plugin-sdk` — what a QAuth sign-in method plugin is written
+ * against: the AuthMethod contract (`qauth-auth-method/1-rc.0`).
+ *
+ * EXPERIMENTAL. The contract is QAuth's plugin API, the experimental item
+ * `plugin-api` (ADR-018 §4): public and documented, but outside the 1.0
+ * stability promise, so it may change in a minor release. A breaking change to
+ * anything this package exports raises {@link AUTH_METHOD_CONTRACT_VERSION}, and
+ * the server refuses a plugin written against another version.
+ *
+ * Three entry points:
+ *
+ * - this one: the `AuthMethod` interface and the types it uses, the contract's
+ *   constants, its errors and the static checks the server's registry runs;
+ * - `@qauth-labs/plugin-sdk/testing`: the contract test kit,
+ *   `checkAuthMethod`, for a plugin's own tests;
+ * - `@qauth-labs/plugin-sdk/host`: the host's half, which QAuth's server
+ *   imports and the test kit runs (the engine's checks around a method's
+ *   answers, the context a method is handed). A plugin does not need it.
+ *
+ * See the package README and `examples/minimal-plugin`.
+ *
+ * @packageDocumentation
+ */
+// The contract's fixed values: its version, the plugin export, the step, the
+// route prefix, the patterns and the caps.
+export * from './lib/contract.js';
+// The errors of the contract.
+export { AuthMethodConfigError, AuthMethodContractError, AuthMethodFaultError, } from './lib/errors.js';
+// The static checks the server's registry and loader run on a method.
+export { assertAuthMethod, authMethodProblems, isAuthMethod } from './lib/validate.js';