@guideveloper/design-assets 0.1.9 → 0.1.11

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.
package/README.md CHANGED
@@ -1,27 +1,24 @@
1
1
  # Design Asset Library
2
2
 
3
- Source of truth for icons, illustrations, and animations. Generates React components, Storybook, metadata exports, and publishes as `@guideveloper/design-assets`.
3
+ Source of truth for icons, illustrations, and animations. Generates React components, metadata exports, and publishes as `@guideveloper/design-assets`.
4
4
 
5
5
  ## Structure
6
6
  - `assets/` raw assets + metadata
7
- - `scripts/generateAssets.ts` scans assets and builds components, metadata, and stories
7
+ - `scripts/generateAssets.ts` scans assets and builds components + metadata
8
8
  - `src/components` generated React components
9
9
  - `src/metadata` generated metadata arrays
10
- - `.storybook` Storybook config
11
10
 
12
11
  ## Commands
13
- - `npm run generate-assets` – generate components/stories/metadata from `assets`
14
- - `npm run storybook` – run Storybook locally
15
- - `npm run build-storybook` – build static Storybook
12
+ - `npm run generate-assets` – generate components/metadata from `assets`
16
13
  - `npm run build` – bundle library via tsup (ESM + CJS)
17
14
 
18
15
  ## Workflow
19
16
  1. Add/update files under `assets/icons|illustrations|animations` (with matching `.json` metadata files).
20
17
  2. Run `npm install` then `npm run generate-assets`.
21
- 3. Open Storybook (`npm run storybook`) to review.
22
- 4. When you want a release, manually trigger the workflow (`.github/workflows/codegen-and-publish.yml`) which runs codegen, bumps the version, builds Storybook, builds the package, publishes Storybook to `gh-pages`, publishes to npm, and pushes the tagged release back to `master`.
18
+ 3. When you want a release, manually trigger the workflow (`.github/workflows/codegen-and-publish.yml`) which runs codegen, bumps the version, builds the package, publishes to npm, and pushes the tagged release back to `master`.
23
19
 
24
20
  ## Asset metadata format
21
+ - **Naming**: Use kebab-case file names (e.g. `pleased-to-meet-you`). Long multi-word names without separators will fail generation.
25
22
  - **Icon**: `assets/icons/name.svg` + `assets/icons/name.json` `{ name, tags?, description? }`
26
23
  - **Illustration**: `assets/illustrations/name.svg|png` + `assets/illustrations/name.json` `{ name, category?, tags?, description? }`
27
24
  - **Animation**: `assets/animations/name.json` (Lottie) + `assets/animations/name.meta.json` `{ name, frameRate?, loop?, tags?, description? }`
@@ -29,10 +26,9 @@ Source of truth for icons, illustrations, and animations. Generates React compon
29
26
  ## Publishing
30
27
  Set secrets:
31
28
  - `NPM_TOKEN` for npm publish
32
- - Use default `GITHUB_TOKEN` for Storybook deploy to `gh-pages`
33
29
 
34
30
  Package name: `@guideveloper/design-assets`
35
31
 
36
32
  ### Manual release button
37
- - GitHub Actions has a built-in “Run workflow” button for `Manual Codegen, Storybook, and Publish` (workflow dispatch only; no auto-runs on `master`).
38
- - A lightweight front-end trigger lives at `scripts/run-manual-build.html` with a “Run workflow” button. Open the file in a browser, provide a GitHub token with `workflow` scope (and `repo`/`public_repo` as needed), choose the bump type, and optionally publish Storybook. It dispatches the workflow on `master`.
33
+ - GitHub Actions has a built-in “Run workflow” button for `Manual Codegen and Publish` (workflow dispatch only; no auto-runs on `master`).
34
+ - A lightweight front-end trigger lives at `scripts/run-manual-build.html` with a “Run workflow” button. Open the file in a browser, provide a GitHub token with `workflow` scope (and `repo`/`public_repo` as needed), choose the bump type, and dispatch the workflow on `master`.
package/dist/index.d.mts CHANGED
@@ -28,13 +28,19 @@ declare const AnimationBounce: React.FC<{
28
28
  className?: string;
29
29
  } & Partial<React.ComponentProps<typeof Lottie>>>;
30
30
 
31
- declare const AnimationCardordersuccess: React.FC<{
31
+ declare const AnimationCardOrderSuccess: React.FC<{
32
32
  loop?: boolean;
33
33
  autoplay?: boolean;
34
34
  className?: string;
35
35
  } & Partial<React.ComponentProps<typeof Lottie>>>;
36
36
 
37
- declare const AnimationLoadinghourglasspurple: React.FC<{
37
+ declare const AnimationLoadingHourglassPurple: React.FC<{
38
+ loop?: boolean;
39
+ autoplay?: boolean;
40
+ className?: string;
41
+ } & Partial<React.ComponentProps<typeof Lottie>>>;
42
+
43
+ declare const AnimationPleasedToMeetYou: React.FC<{
38
44
  loop?: boolean;
39
45
  autoplay?: boolean;
40
46
  className?: string;
@@ -96,12 +102,17 @@ declare const animations: readonly [{
96
102
  readonly tags: readonly ["motion", "loop"];
97
103
  readonly description: "Simple bouncing ball animation";
98
104
  }, {
99
- readonly name: "cardordersuccess";
105
+ readonly name: "card-order-success";
106
+ readonly frameRate: 30;
107
+ readonly loop: true;
108
+ readonly tags: readonly [];
109
+ }, {
110
+ readonly name: "loading-hourglass-purple";
100
111
  readonly frameRate: 30;
101
112
  readonly loop: true;
102
113
  readonly tags: readonly [];
103
114
  }, {
104
- readonly name: "loadinghourglasspurple";
115
+ readonly name: "pleased-to-meet-you";
105
116
  readonly frameRate: 30;
106
117
  readonly loop: true;
107
118
  readonly tags: readonly [];
@@ -115,4 +126,4 @@ type IconMetadata = typeof icons[number];
115
126
  type IllustrationMetadata = typeof illustrations[number];
116
127
  type AnimationMetadata = typeof animations[number];
117
128
 
118
- export { AnimationBounce, AnimationCardordersuccess, AnimationLoadinghourglasspurple, AnimationMetadata, AnimationPulse, IconAmbulance, IconAtom, IconCableCar, IconCheeseIcon, IconCheeseIcon2, IconHeartActivity, IconMetadata, IconSearch, IllustrationMetadata, IllustrationRoosterHead, IllustrationSunrise, IllustrationSvgIcon, animations, icons, illustrations };
129
+ export { AnimationBounce, AnimationCardOrderSuccess, AnimationLoadingHourglassPurple, AnimationMetadata, AnimationPleasedToMeetYou, AnimationPulse, IconAmbulance, IconAtom, IconCableCar, IconCheeseIcon, IconCheeseIcon2, IconHeartActivity, IconMetadata, IconSearch, IllustrationMetadata, IllustrationRoosterHead, IllustrationSunrise, IllustrationSvgIcon, animations, icons, illustrations };
package/dist/index.d.ts CHANGED
@@ -28,13 +28,19 @@ declare const AnimationBounce: React.FC<{
28
28
  className?: string;
29
29
  } & Partial<React.ComponentProps<typeof Lottie>>>;
30
30
 
31
- declare const AnimationCardordersuccess: React.FC<{
31
+ declare const AnimationCardOrderSuccess: React.FC<{
32
32
  loop?: boolean;
33
33
  autoplay?: boolean;
34
34
  className?: string;
35
35
  } & Partial<React.ComponentProps<typeof Lottie>>>;
36
36
 
37
- declare const AnimationLoadinghourglasspurple: React.FC<{
37
+ declare const AnimationLoadingHourglassPurple: React.FC<{
38
+ loop?: boolean;
39
+ autoplay?: boolean;
40
+ className?: string;
41
+ } & Partial<React.ComponentProps<typeof Lottie>>>;
42
+
43
+ declare const AnimationPleasedToMeetYou: React.FC<{
38
44
  loop?: boolean;
39
45
  autoplay?: boolean;
40
46
  className?: string;
@@ -96,12 +102,17 @@ declare const animations: readonly [{
96
102
  readonly tags: readonly ["motion", "loop"];
97
103
  readonly description: "Simple bouncing ball animation";
98
104
  }, {
99
- readonly name: "cardordersuccess";
105
+ readonly name: "card-order-success";
106
+ readonly frameRate: 30;
107
+ readonly loop: true;
108
+ readonly tags: readonly [];
109
+ }, {
110
+ readonly name: "loading-hourglass-purple";
100
111
  readonly frameRate: 30;
101
112
  readonly loop: true;
102
113
  readonly tags: readonly [];
103
114
  }, {
104
- readonly name: "loadinghourglasspurple";
115
+ readonly name: "pleased-to-meet-you";
105
116
  readonly frameRate: 30;
106
117
  readonly loop: true;
107
118
  readonly tags: readonly [];
@@ -115,4 +126,4 @@ type IconMetadata = typeof icons[number];
115
126
  type IllustrationMetadata = typeof illustrations[number];
116
127
  type AnimationMetadata = typeof animations[number];
117
128
 
118
- export { AnimationBounce, AnimationCardordersuccess, AnimationLoadinghourglasspurple, AnimationMetadata, AnimationPulse, IconAmbulance, IconAtom, IconCableCar, IconCheeseIcon, IconCheeseIcon2, IconHeartActivity, IconMetadata, IconSearch, IllustrationMetadata, IllustrationRoosterHead, IllustrationSunrise, IllustrationSvgIcon, animations, icons, illustrations };
129
+ export { AnimationBounce, AnimationCardOrderSuccess, AnimationLoadingHourglassPurple, AnimationMetadata, AnimationPleasedToMeetYou, AnimationPulse, IconAmbulance, IconAtom, IconCableCar, IconCheeseIcon, IconCheeseIcon2, IconHeartActivity, IconMetadata, IconSearch, IllustrationMetadata, IllustrationRoosterHead, IllustrationSunrise, IllustrationSvgIcon, animations, icons, illustrations };