@guideveloper/design-assets 0.1.10 → 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,19 +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
38
  loop?: boolean;
39
39
  autoplay?: boolean;
40
40
  className?: string;
41
41
  } & Partial<React.ComponentProps<typeof Lottie>>>;
42
42
 
43
- declare const AnimationPleasedtomeetyou: React.FC<{
43
+ declare const AnimationPleasedToMeetYou: React.FC<{
44
44
  loop?: boolean;
45
45
  autoplay?: boolean;
46
46
  className?: string;
@@ -102,17 +102,17 @@ declare const animations: readonly [{
102
102
  readonly tags: readonly ["motion", "loop"];
103
103
  readonly description: "Simple bouncing ball animation";
104
104
  }, {
105
- readonly name: "cardordersuccess";
105
+ readonly name: "card-order-success";
106
106
  readonly frameRate: 30;
107
107
  readonly loop: true;
108
108
  readonly tags: readonly [];
109
109
  }, {
110
- readonly name: "loadinghourglasspurple";
110
+ readonly name: "loading-hourglass-purple";
111
111
  readonly frameRate: 30;
112
112
  readonly loop: true;
113
113
  readonly tags: readonly [];
114
114
  }, {
115
- readonly name: "pleasedtomeetyou";
115
+ readonly name: "pleased-to-meet-you";
116
116
  readonly frameRate: 30;
117
117
  readonly loop: true;
118
118
  readonly tags: readonly [];
@@ -126,4 +126,4 @@ type IconMetadata = typeof icons[number];
126
126
  type IllustrationMetadata = typeof illustrations[number];
127
127
  type AnimationMetadata = typeof animations[number];
128
128
 
129
- export { AnimationBounce, AnimationCardordersuccess, AnimationLoadinghourglasspurple, AnimationMetadata, AnimationPleasedtomeetyou, 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,19 +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
38
  loop?: boolean;
39
39
  autoplay?: boolean;
40
40
  className?: string;
41
41
  } & Partial<React.ComponentProps<typeof Lottie>>>;
42
42
 
43
- declare const AnimationPleasedtomeetyou: React.FC<{
43
+ declare const AnimationPleasedToMeetYou: React.FC<{
44
44
  loop?: boolean;
45
45
  autoplay?: boolean;
46
46
  className?: string;
@@ -102,17 +102,17 @@ declare const animations: readonly [{
102
102
  readonly tags: readonly ["motion", "loop"];
103
103
  readonly description: "Simple bouncing ball animation";
104
104
  }, {
105
- readonly name: "cardordersuccess";
105
+ readonly name: "card-order-success";
106
106
  readonly frameRate: 30;
107
107
  readonly loop: true;
108
108
  readonly tags: readonly [];
109
109
  }, {
110
- readonly name: "loadinghourglasspurple";
110
+ readonly name: "loading-hourglass-purple";
111
111
  readonly frameRate: 30;
112
112
  readonly loop: true;
113
113
  readonly tags: readonly [];
114
114
  }, {
115
- readonly name: "pleasedtomeetyou";
115
+ readonly name: "pleased-to-meet-you";
116
116
  readonly frameRate: 30;
117
117
  readonly loop: true;
118
118
  readonly tags: readonly [];
@@ -126,4 +126,4 @@ type IconMetadata = typeof icons[number];
126
126
  type IllustrationMetadata = typeof illustrations[number];
127
127
  type AnimationMetadata = typeof animations[number];
128
128
 
129
- export { AnimationBounce, AnimationCardordersuccess, AnimationLoadinghourglasspurple, AnimationMetadata, AnimationPleasedtomeetyou, 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.js CHANGED
@@ -13512,7 +13512,7 @@ var animationData2 = {
13512
13512
  }
13513
13513
  ]
13514
13514
  };
13515
- var AnimationCardordersuccess = ({ loop = true, autoplay = true, ...rest }) => {
13515
+ var AnimationCardOrderSuccess = ({ loop = true, autoplay = true, ...rest }) => {
13516
13516
  return /* @__PURE__ */ jsxRuntime.jsx(Lottie__default.default, { animationData: animationData2, loop, autoplay, ...rest });
13517
13517
  };
13518
13518
  var animationData3 = {
@@ -16997,7 +16997,7 @@ var animationData3 = {
16997
16997
  }
16998
16998
  ]
16999
16999
  };
17000
- var AnimationLoadinghourglasspurple = ({ loop = true, autoplay = true, ...rest }) => {
17000
+ var AnimationLoadingHourglassPurple = ({ loop = true, autoplay = true, ...rest }) => {
17001
17001
  return /* @__PURE__ */ jsxRuntime.jsx(Lottie__default.default, { animationData: animationData3, loop, autoplay, ...rest });
17002
17002
  };
17003
17003
  var animationData4 = {
@@ -26931,7 +26931,7 @@ var animationData4 = {
26931
26931
  }
26932
26932
  ]
26933
26933
  };
26934
- var AnimationPleasedtomeetyou = ({ loop = true, autoplay = true, ...rest }) => {
26934
+ var AnimationPleasedToMeetYou = ({ loop = true, autoplay = true, ...rest }) => {
26935
26935
  return /* @__PURE__ */ jsxRuntime.jsx(Lottie__default.default, { animationData: animationData4, loop, autoplay, ...rest });
26936
26936
  };
26937
26937
  var animationData5 = {
@@ -27272,19 +27272,19 @@ var animations = [
27272
27272
  "description": "Simple bouncing ball animation"
27273
27273
  },
27274
27274
  {
27275
- "name": "cardordersuccess",
27275
+ "name": "card-order-success",
27276
27276
  "frameRate": 30,
27277
27277
  "loop": true,
27278
27278
  "tags": []
27279
27279
  },
27280
27280
  {
27281
- "name": "loadinghourglasspurple",
27281
+ "name": "loading-hourglass-purple",
27282
27282
  "frameRate": 30,
27283
27283
  "loop": true,
27284
27284
  "tags": []
27285
27285
  },
27286
27286
  {
27287
- "name": "pleasedtomeetyou",
27287
+ "name": "pleased-to-meet-you",
27288
27288
  "frameRate": 30,
27289
27289
  "loop": true,
27290
27290
  "tags": []
@@ -27301,9 +27301,9 @@ var animations = [
27301
27301
  ];
27302
27302
 
27303
27303
  exports.AnimationBounce = AnimationBounce;
27304
- exports.AnimationCardordersuccess = AnimationCardordersuccess;
27305
- exports.AnimationLoadinghourglasspurple = AnimationLoadinghourglasspurple;
27306
- exports.AnimationPleasedtomeetyou = AnimationPleasedtomeetyou;
27304
+ exports.AnimationCardOrderSuccess = AnimationCardOrderSuccess;
27305
+ exports.AnimationLoadingHourglassPurple = AnimationLoadingHourglassPurple;
27306
+ exports.AnimationPleasedToMeetYou = AnimationPleasedToMeetYou;
27307
27307
  exports.AnimationPulse = AnimationPulse;
27308
27308
  exports.IconAmbulance = IconAmbulance;
27309
27309
  exports.IconAtom = IconAtom;