@promptframe/component-kit 0.1.2 → 0.1.5

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 (6) hide show
  1. package/README.md +38 -19
  2. package/dist/standard.d.ts +4 -4
  3. package/dist/standard.d.ts.map +1 -1
  4. package/dist/standard.js +6 -5
  5. package/dist/standard.js.map +1 -1
  6. package/package.json +11 -8
package/README.md CHANGED
@@ -1,36 +1,55 @@
1
1
  # @promptframe/component-kit
2
2
 
3
- Stable helper package for Remotion marketplace component authors.
3
+ TypeScript helpers for building PromptFrame-compatible Remotion components.
4
4
 
5
- This package is intentionally small. It exposes standard stamps, preview constraints, and deterministic timing helpers that external/private components can depend on without importing renderer internals.
5
+ ```bash
6
+ npm install @promptframe/component-kit
7
+ ```
8
+
9
+ ## What It Includes
10
+
11
+ - Standard version stamps for component metadata, sourced from `@promptframe/contracts`.
12
+ - Preview constraints used by PromptFrame component tooling.
13
+ - Timing helpers for deterministic Remotion animations.
6
14
 
7
- ## Public Entrypoints
15
+ ## Usage
8
16
 
9
17
  ```ts
10
18
  import { getComponentStandardStamp } from '@promptframe/component-kit';
19
+
20
+ export const manifest = {
21
+ name: 'sales-funnel-scene',
22
+ standard: getComponentStandardStamp(),
23
+ };
24
+ ```
25
+
26
+ ```ts
11
27
  import { COMPONENT_PREVIEW_CONSTRAINTS } from '@promptframe/component-kit/preview';
12
- import { createDurationTimeline } from '@promptframe/component-kit/timing';
28
+
29
+ export const previewSize = COMPONENT_PREVIEW_CONSTRAINTS.defaultStill;
13
30
  ```
14
31
 
15
- The package does not replace server-side admission. Uploads must still pass build admission, deterministic security review, manifest/schema/policy validation, evidence indexing, artifact mirror, and `get_component_schema` before Director can use the component.
32
+ ```ts
33
+ import { createDurationTimeline } from '@promptframe/component-kit/timing';
16
34
 
17
- ## Authoring Rules
35
+ const timeline = createDurationTimeline({
36
+ durationInFrames: 180,
37
+ fps: 30,
38
+ });
39
+ ```
18
40
 
19
- - Do not import `@remotion-media/renderer` or repo-internal paths from component packages.
20
- - Keep Remotion/React as the component project's own dependencies; `component-kit` declares them as optional peers only for future helper compatibility.
21
- - Treat `getComponentStandardStamp()` as a local development stamp. The platform API and server admission remain the final SSOT.
22
- - Use `component-market validate --online` before upload and `component-market upload` for admission.
41
+ ## Entrypoints
23
42
 
24
- ## Publishing Status
43
+ ```ts
44
+ import { getComponentStandardStamp } from '@promptframe/component-kit';
45
+ import { COMPONENT_PREVIEW_CONSTRAINTS } from '@promptframe/component-kit/preview';
46
+ import { createDurationTimeline } from '@promptframe/component-kit/timing';
47
+ ```
25
48
 
26
- The package is published publicly. The confirmed public coordinates are:
49
+ ## Peer Dependencies
27
50
 
28
- - npm package: `@promptframe/component-kit`
29
- - npm org/scope: `@promptframe`
30
- - current version: `0.1.2`
31
- - release repository: `https://github.com/ty-teams/promptframe-component-kit`
32
- - license: MIT
51
+ `react` and `remotion` are optional peer dependencies. Component projects should install the versions they build and preview with.
33
52
 
34
- The initial npm release is complete, and npm Trusted Publisher is configured for `ty-teams/promptframe-component-kit` / `publish-component-kit.yml` / `npm-production`. Future releases should use GitHub Actions Trusted Publishing.
53
+ ## Component Workflow
35
54
 
36
- Marketplace/private components themselves do not publish to npm. They still move through platform CLI upload, build admission, security review, schema/policy/receipt generation, evidence indexing, artifact mirror, and resolver-backed preview/render.
55
+ Use this package while authoring components. Use the PromptFrame CLI to validate, package, and upload finished components.
package/dist/standard.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  export declare const COMPONENT_STANDARD_VERSION: "component-standard.v0.1.0";
2
2
  export declare const COMPONENT_STANDARD_SOURCE_HASH: "sha256:8c1e01c36155b4b646981064d24df9bd8cda501fd9cd9da93e5b62f40db22d52";
3
- export declare const COMPONENT_STANDARD_SOURCE_PATH: "docs/requirements/REQ-073/component-standard.md";
4
- export declare const COMPONENT_KIT_VERSION: "0.1.2";
3
+ export declare const COMPONENT_STANDARD_SOURCE_PATH: "https://github.com/ty-teams/promptframe-component-authoring#readme";
4
+ export declare const COMPONENT_KIT_VERSION: "0.1.5";
5
5
  export declare const COMPONENT_MANIFEST_SCHEMA_VERSION: "component-manifest.v0.1.0";
6
6
  export declare const COMPONENT_REVIEW_CHECKLIST_VERSION: "component-review-checklist.v0.1.0";
7
7
  export declare function getComponentStandardStamp(): {
8
8
  sourceVersion: "component-standard.v0.1.0";
9
9
  sourceHash: "sha256:8c1e01c36155b4b646981064d24df9bd8cda501fd9cd9da93e5b62f40db22d52";
10
- sourcePath: "docs/requirements/REQ-073/component-standard.md";
11
- componentKitVersion: "0.1.2";
10
+ sourcePath: "https://github.com/ty-teams/promptframe-component-authoring#readme";
11
+ componentKitVersion: "0.1.5";
12
12
  manifestSchemaVersion: "component-manifest.v0.1.0";
13
13
  reviewChecklistVersion: "component-review-checklist.v0.1.0";
14
14
  };
package/dist/standard.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../src/standard.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,EAAG,2BAAoC,CAAC;AAC/E,eAAO,MAAM,8BAA8B,EAAG,yEAAkF,CAAC;AACjI,eAAO,MAAM,8BAA8B,EAAG,iDAA0D,CAAC;AACzG,eAAO,MAAM,qBAAqB,EAAG,OAAgB,CAAC;AACtD,eAAO,MAAM,iCAAiC,EAAG,2BAAoC,CAAC;AACtF,eAAO,MAAM,kCAAkC,EAAG,mCAA4C,CAAC;AAE/F,wBAAgB,yBAAyB;;;;;;;EASxC"}
1
+ {"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../src/standard.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,0BAA0B,6BAAuC,CAAC;AAC/E,eAAO,MAAM,8BAA8B,2EAA2C,CAAC;AACvF,eAAO,MAAM,8BAA8B,EAAG,oEAA6E,CAAC;AAC5H,eAAO,MAAM,qBAAqB,EAAG,OAAgB,CAAC;AACtD,eAAO,MAAM,iCAAiC,6BAA8C,CAAC;AAC7F,eAAO,MAAM,kCAAkC,EAAG,mCAA4C,CAAC;AAE/F,wBAAgB,yBAAyB;;;;;;;EASxC"}
package/dist/standard.js CHANGED
@@ -1,8 +1,9 @@
1
- export const COMPONENT_STANDARD_VERSION = 'component-standard.v0.1.0';
2
- export const COMPONENT_STANDARD_SOURCE_HASH = 'sha256:8c1e01c36155b4b646981064d24df9bd8cda501fd9cd9da93e5b62f40db22d52';
3
- export const COMPONENT_STANDARD_SOURCE_PATH = 'docs/requirements/REQ-073/component-standard.md';
4
- export const COMPONENT_KIT_VERSION = '0.1.2';
5
- export const COMPONENT_MANIFEST_SCHEMA_VERSION = 'component-manifest.v0.1.0';
1
+ import { COMPONENT_MANIFEST_SCHEMA_VERSION as CONTRACTS_COMPONENT_MANIFEST_SCHEMA_VERSION, COMPONENT_STANDARD_SOURCE_HASH as CONTRACTS_COMPONENT_STANDARD_SOURCE_HASH, COMPONENT_STANDARD_VERSION as CONTRACTS_COMPONENT_STANDARD_VERSION, } from '@promptframe/contracts';
2
+ export const COMPONENT_STANDARD_VERSION = CONTRACTS_COMPONENT_STANDARD_VERSION;
3
+ export const COMPONENT_STANDARD_SOURCE_HASH = CONTRACTS_COMPONENT_STANDARD_SOURCE_HASH;
4
+ export const COMPONENT_STANDARD_SOURCE_PATH = 'https://github.com/ty-teams/promptframe-component-authoring#readme';
5
+ export const COMPONENT_KIT_VERSION = '0.1.5';
6
+ export const COMPONENT_MANIFEST_SCHEMA_VERSION = CONTRACTS_COMPONENT_MANIFEST_SCHEMA_VERSION;
6
7
  export const COMPONENT_REVIEW_CHECKLIST_VERSION = 'component-review-checklist.v0.1.0';
7
8
  export function getComponentStandardStamp() {
8
9
  return {
package/dist/standard.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"standard.js","sourceRoot":"","sources":["../src/standard.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,0BAA0B,GAAG,2BAAoC,CAAC;AAC/E,MAAM,CAAC,MAAM,8BAA8B,GAAG,yEAAkF,CAAC;AACjI,MAAM,CAAC,MAAM,8BAA8B,GAAG,iDAA0D,CAAC;AACzG,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAgB,CAAC;AACtD,MAAM,CAAC,MAAM,iCAAiC,GAAG,2BAAoC,CAAC;AACtF,MAAM,CAAC,MAAM,kCAAkC,GAAG,mCAA4C,CAAC;AAE/F,MAAM,UAAU,yBAAyB;IACvC,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,8BAA8B;QAC1C,mBAAmB,EAAE,qBAAqB;QAC1C,qBAAqB,EAAE,iCAAiC;QACxD,sBAAsB,EAAE,kCAAkC;KAC3D,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"standard.js","sourceRoot":"","sources":["../src/standard.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,IAAI,2CAA2C,EAChF,8BAA8B,IAAI,wCAAwC,EAC1E,0BAA0B,IAAI,oCAAoC,GACnE,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAC/E,MAAM,CAAC,MAAM,8BAA8B,GAAG,wCAAwC,CAAC;AACvF,MAAM,CAAC,MAAM,8BAA8B,GAAG,oEAA6E,CAAC;AAC5H,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAgB,CAAC;AACtD,MAAM,CAAC,MAAM,iCAAiC,GAAG,2CAA2C,CAAC;AAC7F,MAAM,CAAC,MAAM,kCAAkC,GAAG,mCAA4C,CAAC;AAE/F,MAAM,UAAU,yBAAyB;IACvC,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,8BAA8B;QAC1C,mBAAmB,EAAE,qBAAqB;QAC1C,qBAAqB,EAAE,iCAAiC;QACxD,sBAAsB,EAAE,kCAAkC;KAC3D,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptframe/component-kit",
3
- "version": "0.1.2",
3
+ "version": "0.1.5",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -38,20 +38,23 @@
38
38
  },
39
39
  "repository": {
40
40
  "type": "git",
41
- "url": "git+https://github.com/ty-teams/promptframe-component-kit.git",
41
+ "url": "git+https://github.com/ty-teams/promptframe-component-authoring.git",
42
42
  "directory": "packages/component-kit"
43
43
  },
44
44
  "bugs": {
45
- "url": "https://github.com/ty-teams/promptframe-component-kit/issues"
45
+ "url": "https://github.com/ty-teams/promptframe-component-authoring/issues"
46
46
  },
47
- "homepage": "https://github.com/ty-teams/promptframe-component-kit#readme",
47
+ "homepage": "https://github.com/ty-teams/promptframe-component-authoring#readme",
48
48
  "scripts": {
49
- "build": "tsc",
50
- "lint": "tsc --noEmit",
51
- "test": "node --import tsx --test test/*.test.ts",
49
+ "build": "pnpm --filter @promptframe/contracts build && tsc",
50
+ "lint": "pnpm --filter @promptframe/contracts build && tsc --noEmit",
51
+ "test": "pnpm --filter @promptframe/contracts build && node --import tsx --test test/*.test.ts",
52
+ "pack:dry-run": "pnpm build && npm pack --dry-run --json",
52
53
  "clean": "rm -rf dist"
53
54
  },
54
- "dependencies": {},
55
+ "dependencies": {
56
+ "@promptframe/contracts": "^0.1.2"
57
+ },
55
58
  "peerDependencies": {
56
59
  "react": "^19.0.0",
57
60
  "remotion": "^4.0.0"