@biggive/components 0.0.18 → 0.0.20

package/dist/cjs/biggive.cjs.js

@@ -3,7 +3,7 @@
 const index = require('./index-8692cc53.js');
 
 /*
- Stencil Client Patch Browser v2.17.1 | MIT Licensed | https://stenciljs.com
+ Stencil Client Patch Browser v2.17.3 | MIT Licensed | https://stenciljs.com
  */
 const patchBrowser = () => {
     const importMeta = (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('biggive.cjs.js', document.baseURI).href));

package/dist/cjs/loader.cjs.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 const index = require('./index-8692cc53.js');
 
 /*
- Stencil Client Patch Esm v2.17.1 | MIT Licensed | https://stenciljs.com
+ Stencil Client Patch Esm v2.17.3 | MIT Licensed | https://stenciljs.com
  */
 const patchEsm = () => {
     return index.promiseResolve();

package/dist/collection/collection-manifest.json

@@ -6,7 +6,7 @@
   ],
   "compiler": {
     "name": "@stencil/core",
-    "version": "2.17.1",
+    "version": "2.17.3",
     "typescriptVersion": "4.5.4"
   },
   "collections": [],

package/dist/collection/components/biggive-campaign-card/biggive-campaign-card.js

@@ -1,8 +1,5 @@
 import { Component, Prop, h } from '@stencil/core';
 import { CampaignGroupsService } from '../../util/campaign-groups';
-/**
- * @todo Currency code for the campaign must be passed as a `@Prop`, not localised to the prospective donor.
- */
 export class BiggiveCampaignCard {
   constructor() {
     /**

package/dist/esm/biggive.js

@@ -1,7 +1,7 @@
 import { p as promiseResolve, b as bootstrapLazy } from './index-4c3bc0b8.js';
 
 /*
- Stencil Client Patch Browser v2.17.1 | MIT Licensed | https://stenciljs.com
+ Stencil Client Patch Browser v2.17.3 | MIT Licensed | https://stenciljs.com
  */
 const patchBrowser = () => {
     const importMeta = import.meta.url;

package/dist/esm/loader.js

@@ -1,7 +1,7 @@
 import { p as promiseResolve, b as bootstrapLazy } from './index-4c3bc0b8.js';
 
 /*
- Stencil Client Patch Esm v2.17.1 | MIT Licensed | https://stenciljs.com
+ Stencil Client Patch Esm v2.17.3 | MIT Licensed | https://stenciljs.com
  */
 const patchEsm = () => {
     return promiseResolve();

package/dist/types/components/biggive-campaign-card/biggive-campaign-card.d.ts

@@ -1,6 +1,3 @@
-/**
- * @todo Currency code for the campaign must be passed as a `@Prop`, not localised to the prospective donor.
- */
 export declare class BiggiveCampaignCard {
   /**
    * Full URL of a banner image.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biggive/components",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "Big Give Components",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",

package/readme.md

@@ -45,6 +45,28 @@ Anything externally managed should be loaded with npm and no copies checked into
 
 Generated build outputs should similarly be `.gitignore`d.
 
+Because Stencil components have *partly* generated readme docs, it is a good idea after changing any `@Prop`s or similar to `npm run build`
+before committing your changes. The docs should be source controlled as they can include manual content. If you make a new one, it's a good
+idea to add a one line description of its purpose to the readme before the generated section.
+
+### Output targets
+
+Main targets are:
+
+* `angularOutputTarget()` – used in [Donate frontend](https://github.com/thebiggive/donate-frontend).
+* `dist-custom-elements` – the docs don't make this terribly clear but with our current configuration,
+  these are a dependency for the Angular project/target to build successfully. Angular needs to be told
+  that they live inside `dist/` (so are published in `dist/components`).
+* `dist` for general web modules – used in [WordPress](https://github.com/thebiggive/wordpress).
+* Storybook has its own build step using the component from source. Currently, this is also used in
+  Salesforce to embed components in iframes, the only feasible way we've been able to get Experiences
+  to dynamically pull in components.
+* `docs-readme` for documentation.
+
+Targets we have but just for local experiments:
+
+* `www`
+
 ### Angular components
 
 As well as the core package `@biggive/components`, CI automatically publishes a version best tailored to
@@ -110,6 +132,11 @@ CI automatically publishes the Storybook preview:
 * to [its Production site](https://components-production.thebiggive.org.uk) on *tagged* pushes
   (typically also on `main`) – intended for tested, new versions which are also to be npm published.
 
+For now, the local `npm run storybook` won't load static image assets or fonts. We've prioritised realistic
+renders in the deployed environment, where these work due to:
+* CI separately copying the main build's `assets` output to S3: see e.g. `deploy-staging-storybook` in [CI config](./.circleci/config.yml)
+* Storybook having a custom [`preview-head.html`](./.storybook/preview-head.html).
+
 ## Publish to NPM
 
 ### Connect to NPM