@well-known-js/core 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +55 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # @well-known-js/core
2
+
3
+ Shared types and configuration helpers for the `@well-known-js` ecosystem.
4
+
5
+ ## Installation
6
+
7
+ ```sh
8
+ pnpm add @well-known-js/core
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Create a `well-known.config.ts` file and register one or more providers:
14
+
15
+ ```ts
16
+ import { defineConfig } from "@well-known-js/core";
17
+ import { assetLinks } from "@well-known-js/assetlinks";
18
+
19
+ export default defineConfig({
20
+ providers: [
21
+ assetLinks({
22
+ statements: [{ include: "https://example.com/.well-known/assetlinks.json" }],
23
+ }),
24
+ ],
25
+ });
26
+ ```
27
+
28
+ `defineConfig()` validates that provider routes are unique and preserves full TypeScript inference.
29
+
30
+ The package also exports the contracts used to create providers and framework adapters:
31
+
32
+ - `WellKnownConfig` describes the shared configuration object;
33
+ - `WellKnownProvider<TConfig>` describes a reusable provider definition;
34
+ - `WellKnownProviderInstance` describes a configured provider;
35
+ - `WellKnownGeneratedFile` describes the generated path, filename, content type, and body.
36
+
37
+ ## Providers
38
+
39
+ - [`@well-known-js/agent-card`](https://www.npmjs.com/package/@well-known-js/agent-card)
40
+ - [`@well-known-js/api-catalog`](https://www.npmjs.com/package/@well-known-js/api-catalog)
41
+ - [`@well-known-js/gpc`](https://www.npmjs.com/package/@well-known-js/gpc)
42
+ - [`@well-known-js/did-web`](https://www.npmjs.com/package/@well-known-js/did-web)
43
+ - [`@well-known-js/did-configuration`](https://www.npmjs.com/package/@well-known-js/did-configuration)
44
+ - [`@well-known-js/mta-sts`](https://www.npmjs.com/package/@well-known-js/mta-sts)
45
+ - [`@well-known-js/sbom`](https://www.npmjs.com/package/@well-known-js/sbom)
46
+ - [`@well-known-js/oauth-authorization-server`](https://www.npmjs.com/package/@well-known-js/oauth-authorization-server)
47
+ - [`@well-known-js/oauth-protected-resource`](https://www.npmjs.com/package/@well-known-js/oauth-protected-resource)
48
+ - [`@well-known-js/apple-app-site-association`](https://www.npmjs.com/package/@well-known-js/apple-app-site-association)
49
+ - [`@well-known-js/assetlinks`](https://www.npmjs.com/package/@well-known-js/assetlinks)
50
+ - [`@well-known-js/security-txt`](https://www.npmjs.com/package/@well-known-js/security-txt)
51
+ - [`@well-known-js/webauthn`](https://www.npmjs.com/package/@well-known-js/webauthn)
52
+ - [`@well-known-js/passkey-endpoints`](https://www.npmjs.com/package/@well-known-js/passkey-endpoints)
53
+ - [`@well-known-js/openid-configuration`](https://www.npmjs.com/package/@well-known-js/openid-configuration)
54
+
55
+ [GitHub](https://github.com/louchebem06/well-known) · [Documentation](https://github.com/louchebem06/well-known#readme)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@well-known-js/core",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Core utilities and types for generating .well-known files.",
5
5
  "license": "MIT",
6
6
  "repository": {