@vibesdotdev/connector-base 0.0.1 → 0.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 (3) hide show
  1. package/README.md +22 -0
  2. package/package.json +7 -9
  3. package/SPEC.md +0 -23
package/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # @vibesdotdev/connector-base
2
+
3
+ Base connector contracts for platform integrations that plug into the Vibes runtime.
4
+
5
+ This package is part of the public Vibes framework package set. The source repository is private while the public repository split is being prepared, so package documentation is published on the Vibes docs site.
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ bun add @vibesdotdev/connector-base
11
+ # or
12
+ npm install @vibesdotdev/connector-base
13
+ ```
14
+
15
+ ## Documentation
16
+
17
+ - Package guide: https://docs.vibes.dev/packages/connector-base
18
+ - Vibes docs: https://docs.vibes.dev
19
+
20
+ ## License
21
+
22
+ MIT
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vibesdotdev/connector-base",
3
- "version": "0.0.1",
4
- "description": "Base connector runtime kind and contracts for platform integrations",
3
+ "version": "0.0.2",
4
+ "description": "Base connector contracts for platform integrations that plug into the Vibes runtime.",
5
5
  "type": "module",
6
6
  "publishConfig": {
7
7
  "registry": "https://registry.npmjs.org",
@@ -24,25 +24,19 @@
24
24
  }
25
25
  },
26
26
  "dependencies": {
27
- "@vibesdotdev/runtime": "0.0.1",
27
+ "@vibesdotdev/runtime": "0.0.2",
28
28
  "zod": "^3.23.8"
29
29
  },
30
30
  "scripts": {
31
31
  "check": "bun --bun tsc -p tsconfig.json --noEmit",
32
32
  "build": "tsc -p tsconfig.json"
33
33
  },
34
- "repository": {
35
- "type": "git",
36
- "url": "git+https://github.com/vibesdotdev/monorepo.git",
37
- "directory": "packages/connector-base"
38
- },
39
34
  "license": "MIT",
40
35
  "files": [
41
36
  "dist",
42
37
  "src",
43
38
  "bin",
44
39
  "README.md",
45
- "SPEC.md",
46
40
  "LICENSE",
47
41
  "!src/**/__tests__/**",
48
42
  "!src/**/__stubs__/**",
@@ -63,5 +57,9 @@
63
57
  ],
64
58
  "vibes": {
65
59
  "visibility": "public-framework"
60
+ },
61
+ "homepage": "https://docs.vibes.dev/packages/connector-base",
62
+ "bugs": {
63
+ "url": "https://docs.vibes.dev/packages/connector-base#support"
66
64
  }
67
65
  }
package/SPEC.md DELETED
@@ -1,23 +0,0 @@
1
- # Connector Base
2
-
3
- ## Ownership
4
-
5
- - **Owns:** Base schemas, interfaces, and resolution utilities for connector packages.
6
- - **Does not own:** Provider-specific implementations (AWS, Azure, GCP).
7
-
8
- ## Description
9
-
10
- The `connector-base` package defines the runtime `connector/substrate` and `connector/sub-connector` kinds.
11
- Substrate packages (`connector-aws`, `connector-azure`, etc.) register descriptors against these kinds and provide concrete service clients (S3, SecretsManager, Blob Storage, etc.).
12
-
13
- ## Public Entrypoints
14
-
15
- - `src/index.ts` — types, schemas, and resolution utilities
16
- - `src/connector.plugin.ts` — runtime plugin for kind registration
17
- - `src/schemas.ts` — `ConnectorSubstrateDescriptorSchema`, `SubConnectorDescriptorSchema`, `CredentialReferenceSchema`, `AwsCredentialsSchema`
18
- - `src/resolver.ts` — `resolveCredentialReference`, `resolveAwsCredentials`, `resolveConfigValue`
19
-
20
- ## Hard Rules
21
-
22
- - No provider-specific imports.
23
- - Must not depend on `@vibesdotdev/secrets` at runtime — accepts `MinimalSecretsStore` shape injected by callers.