@looply/core 0.5.13 → 0.5.17

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/dist/index.d.ts CHANGED
@@ -85,4 +85,5 @@ export * from './graph-queries';
85
85
  export * from './graph-context';
86
86
  export * from './repo-url';
87
87
  export * from './pursuit-end';
88
+ export * from './preview-environment';
88
89
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC"}
package/dist/index.js CHANGED
@@ -101,4 +101,5 @@ __exportStar(require("./graph-queries"), exports);
101
101
  __exportStar(require("./graph-context"), exports);
102
102
  __exportStar(require("./repo-url"), exports);
103
103
  __exportStar(require("./pursuit-end"), exports);
104
+ __exportStar(require("./preview-environment"), exports);
104
105
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,oDAAkC;AAClC,2CAAyB;AACzB,8CAA4B;AAC5B,0CAAwB;AACxB,yCAAuB;AACvB,yCAAuB;AACvB,+CAA6B;AAC7B,kDAAgC;AAChC,kDAAgC;AAChC,uDAAqC;AACrC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,+CAA6B;AAC7B,uDAAqC;AACrC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,kDAAgC;AAChC,gDAA8B;AAC9B,uDAAqC;AACrC,8CAA4B;AAC5B,gDAA8B;AAC9B,gDAA8B;AAC9B,iDAA+B;AAC/B,mDAAiC;AACjC,qDAAmC;AACnC,kDAAgC;AAChC,oDAAkC;AAClC,kDAAgC;AAChC,qDAAmC;AACnC,gDAA8B;AAC9B,oDAAkC;AAClC,iDAA+B;AAC/B,oDAAkC;AAClC,8CAA4B;AAC5B,oDAAkC;AAClC,0DAAwC;AACxC,qDAAmC;AACnC,mDAAiC;AACjC,kDAAgC;AAChC,wDAAsC;AACtC,2CAAyB;AACzB,2CAAyB;AACzB,gDAA8B;AAC9B,2CAAyB;AACzB,4CAA0B;AAC1B,6CAA2B;AAC3B,mDAAiC;AACjC,qDAAmC;AACnC,sDAAoC;AACpC,gDAA8B;AAC9B,sDAAoC;AACpC,gDAA8B;AAC9B,iDAA+B;AAC/B,qDAAmC;AACnC,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,uDAAqC;AACrC,sDAAoC;AACpC,wDAAsC;AACtC,6CAA2B;AAC3B,gDAA8B;AAC9B,4CAA0B;AAC1B,6CAA2B;AAC3B,mDAAiC;AACjC,oDAAkC;AAClC,+CAA6B;AAC7B,6CAA2B;AAC3B,gDAA8B;AAC9B,mDAAiC;AACjC,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,6CAA2B;AAC3B,gDAA8B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,oDAAkC;AAClC,2CAAyB;AACzB,8CAA4B;AAC5B,0CAAwB;AACxB,yCAAuB;AACvB,yCAAuB;AACvB,+CAA6B;AAC7B,kDAAgC;AAChC,kDAAgC;AAChC,uDAAqC;AACrC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,+CAA6B;AAC7B,uDAAqC;AACrC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,kDAAgC;AAChC,gDAA8B;AAC9B,uDAAqC;AACrC,8CAA4B;AAC5B,gDAA8B;AAC9B,gDAA8B;AAC9B,iDAA+B;AAC/B,mDAAiC;AACjC,qDAAmC;AACnC,kDAAgC;AAChC,oDAAkC;AAClC,kDAAgC;AAChC,qDAAmC;AACnC,gDAA8B;AAC9B,oDAAkC;AAClC,iDAA+B;AAC/B,oDAAkC;AAClC,8CAA4B;AAC5B,oDAAkC;AAClC,0DAAwC;AACxC,qDAAmC;AACnC,mDAAiC;AACjC,kDAAgC;AAChC,wDAAsC;AACtC,2CAAyB;AACzB,2CAAyB;AACzB,gDAA8B;AAC9B,2CAAyB;AACzB,4CAA0B;AAC1B,6CAA2B;AAC3B,mDAAiC;AACjC,qDAAmC;AACnC,sDAAoC;AACpC,gDAA8B;AAC9B,sDAAoC;AACpC,gDAA8B;AAC9B,iDAA+B;AAC/B,qDAAmC;AACnC,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,uDAAqC;AACrC,sDAAoC;AACpC,wDAAsC;AACtC,6CAA2B;AAC3B,gDAA8B;AAC9B,4CAA0B;AAC1B,6CAA2B;AAC3B,mDAAiC;AACjC,oDAAkC;AAClC,+CAA6B;AAC7B,6CAA2B;AAC3B,gDAA8B;AAC9B,mDAAiC;AACjC,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,6CAA2B;AAC3B,gDAA8B;AAC9B,wDAAsC"}
@@ -0,0 +1,95 @@
1
+ /**
2
+ * A TEMPORARY SITE PER PULL REQUEST — the shape the server stores and the machine obeys.
3
+ *
4
+ * When Looply opens a pull request for a goal, the branch can be built into a
5
+ * preview site a person opens to try the change ("Test it here →"). Which
6
+ * mechanism builds it is chosen per project, explicitly, never guessed:
7
+ *
8
+ * none — no preview (THE DEFAULT).
9
+ * netlify — Netlify's own deploy previews. Netlify builds every pull request
10
+ * of a connected site by itself; Looply only READS the preview's
11
+ * address and state from what Netlify reports on the pull request.
12
+ * `site` (optional) picks one site when a repository has several.
13
+ * heroku — Heroku review apps on the named `pipeline`. Heroku's automatic
14
+ * review apps build them; Looply reads them. `create: true` lets
15
+ * Looply ask Heroku for one when the pipeline does not make them by
16
+ * itself — that is a new paid app, so it is never the default.
17
+ * command — a command that builds the preview and prints its https address.
18
+ * A remote setting can choose this provider but can NEVER carry the
19
+ * command: the command is only ever what the project's own
20
+ * `.looply/config.yaml` declares (`preview.command`), exactly like
21
+ * `deliver.release`. AutoRyn choosing "command" never runs code that
22
+ * AutoRyn wrote.
23
+ *
24
+ * 🔴 NO SECRETS HERE. Nothing in a setting or a report is a credential: the
25
+ * machine uses its own sign-ins (GitHub CLI / git credential helper, Heroku's
26
+ * own login) and never sends them anywhere but the provider's API. A preview
27
+ * address is reduced to scheme + host + path — any user:password, query string
28
+ * or fragment is dropped before it is stored or shown, because a signed link
29
+ * is a credential.
30
+ */
31
+ export declare const PREVIEW_PROVIDERS: readonly ["none", "netlify", "heroku", "command"];
32
+ export type PreviewProvider = (typeof PREVIEW_PROVIDERS)[number];
33
+ export type PreviewSettings = {
34
+ provider: 'none';
35
+ } | {
36
+ provider: 'netlify';
37
+ site?: string;
38
+ } | {
39
+ provider: 'heroku';
40
+ pipeline: string;
41
+ create?: boolean;
42
+ } | {
43
+ provider: 'command';
44
+ };
45
+ export declare const DEFAULT_PREVIEW_SETTINGS: PreviewSettings;
46
+ export declare function isPreviewProvider(x: unknown): x is PreviewProvider;
47
+ export type PreviewSettingsValidation = {
48
+ ok: true;
49
+ settings: PreviewSettings;
50
+ } | {
51
+ ok: false;
52
+ key: string;
53
+ because: string;
54
+ };
55
+ /** The one rule the server applies on write and the machine on read. */
56
+ export declare function validatePreviewSettings(x: unknown): PreviewSettingsValidation;
57
+ /** One sentence a person reads beside the choice. */
58
+ export declare function describePreview(s: PreviewSettings | null | undefined): string;
59
+ /**
60
+ * WHERE ONE PULL REQUEST'S PREVIEW STANDS.
61
+ *
62
+ * building — the provider is building it (or Looply's command is running)
63
+ * live — it is up; `url` is the address a person opens
64
+ * failed — it did not build, or never appeared; `detail` says why in words
65
+ * removed — the pull request merged or closed and the preview was torn down
66
+ * (or, where the provider keeps it, is no longer updated — `detail` says)
67
+ */
68
+ export declare const PREVIEW_STATES: readonly ["building", "live", "failed", "removed"];
69
+ export type PreviewState = (typeof PREVIEW_STATES)[number];
70
+ export interface PreviewReport {
71
+ provider: Exclude<PreviewProvider, 'none'>;
72
+ state: PreviewState;
73
+ /** The preview's address (scheme + host + path only), or null while there is none. */
74
+ url: string | null;
75
+ /** The pull request it previews. */
76
+ pullRequestUrl: string | null;
77
+ /** The commit it was built from, when known. */
78
+ sha: string | null;
79
+ /** A plain sentence; never a command's output. */
80
+ detail: string | null;
81
+ }
82
+ /**
83
+ * A preview address safe to store and show: https only, no user:password, no
84
+ * query string, no fragment. Null for anything else.
85
+ */
86
+ export declare function safePreviewUrl(raw: unknown): string | null;
87
+ /** A report a machine sent, checked once, the same way on both sides. */
88
+ export declare function validatePreviewReport(x: unknown): {
89
+ ok: true;
90
+ report: PreviewReport;
91
+ } | {
92
+ ok: false;
93
+ because: string;
94
+ };
95
+ //# sourceMappingURL=preview-environment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"preview-environment.d.ts","sourceRoot":"","sources":["../src/preview-environment.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,eAAO,MAAM,iBAAiB,mDAAoD,CAAC;AACnF,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE,MAAM,MAAM,eAAe,GACvB;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GACpB;IAAE,QAAQ,EAAE,SAAS,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1D;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,CAAC;AAE5B,eAAO,MAAM,wBAAwB,EAAE,eAAsC,CAAC;AAM9E,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,eAAe,CAElE;AAED,MAAM,MAAM,yBAAyB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,eAAe,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9H,wEAAwE;AACxE,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAmC7E;AAED,qDAAqD;AACrD,wBAAgB,eAAe,CAAC,CAAC,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAO7E;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,oDAAqD,CAAC;AACjF,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC3C,KAAK,EAAE,YAAY,CAAC;IACpB,sFAAsF;IACtF,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,oCAAoC;IACpC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gDAAgD;IAChD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,kDAAkD;IAClD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAKD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAa1D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,OAAO,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,aAAa,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAgCtH"}
@@ -0,0 +1,174 @@
1
+ "use strict";
2
+ /**
3
+ * A TEMPORARY SITE PER PULL REQUEST — the shape the server stores and the machine obeys.
4
+ *
5
+ * When Looply opens a pull request for a goal, the branch can be built into a
6
+ * preview site a person opens to try the change ("Test it here →"). Which
7
+ * mechanism builds it is chosen per project, explicitly, never guessed:
8
+ *
9
+ * none — no preview (THE DEFAULT).
10
+ * netlify — Netlify's own deploy previews. Netlify builds every pull request
11
+ * of a connected site by itself; Looply only READS the preview's
12
+ * address and state from what Netlify reports on the pull request.
13
+ * `site` (optional) picks one site when a repository has several.
14
+ * heroku — Heroku review apps on the named `pipeline`. Heroku's automatic
15
+ * review apps build them; Looply reads them. `create: true` lets
16
+ * Looply ask Heroku for one when the pipeline does not make them by
17
+ * itself — that is a new paid app, so it is never the default.
18
+ * command — a command that builds the preview and prints its https address.
19
+ * A remote setting can choose this provider but can NEVER carry the
20
+ * command: the command is only ever what the project's own
21
+ * `.looply/config.yaml` declares (`preview.command`), exactly like
22
+ * `deliver.release`. AutoRyn choosing "command" never runs code that
23
+ * AutoRyn wrote.
24
+ *
25
+ * 🔴 NO SECRETS HERE. Nothing in a setting or a report is a credential: the
26
+ * machine uses its own sign-ins (GitHub CLI / git credential helper, Heroku's
27
+ * own login) and never sends them anywhere but the provider's API. A preview
28
+ * address is reduced to scheme + host + path — any user:password, query string
29
+ * or fragment is dropped before it is stored or shown, because a signed link
30
+ * is a credential.
31
+ */
32
+ Object.defineProperty(exports, "__esModule", { value: true });
33
+ exports.PREVIEW_STATES = exports.DEFAULT_PREVIEW_SETTINGS = exports.PREVIEW_PROVIDERS = void 0;
34
+ exports.isPreviewProvider = isPreviewProvider;
35
+ exports.validatePreviewSettings = validatePreviewSettings;
36
+ exports.describePreview = describePreview;
37
+ exports.safePreviewUrl = safePreviewUrl;
38
+ exports.validatePreviewReport = validatePreviewReport;
39
+ exports.PREVIEW_PROVIDERS = ['none', 'netlify', 'heroku', 'command'];
40
+ exports.DEFAULT_PREVIEW_SETTINGS = { provider: 'none' };
41
+ const SITE = /^[A-Za-z0-9][A-Za-z0-9-]{0,62}$/;
42
+ /** A Heroku pipeline's name or its uuid. */
43
+ const PIPELINE = /^(?:[a-z][a-z0-9-]{1,99}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$/;
44
+ function isPreviewProvider(x) {
45
+ return typeof x === 'string' && exports.PREVIEW_PROVIDERS.includes(x);
46
+ }
47
+ /** The one rule the server applies on write and the machine on read. */
48
+ function validatePreviewSettings(x) {
49
+ if (typeof x !== 'object' || x === null || Array.isArray(x)) {
50
+ return { ok: false, key: '<root>', because: 'must be an object like { "provider": "netlify" }' };
51
+ }
52
+ const o = x;
53
+ const provider = o['provider'];
54
+ if (!isPreviewProvider(provider))
55
+ return { ok: false, key: 'provider', because: `must be one of: ${exports.PREVIEW_PROVIDERS.join(', ')}` };
56
+ const allowed = provider === 'netlify' ? ['provider', 'site'] : provider === 'heroku' ? ['provider', 'pipeline', 'create'] : ['provider'];
57
+ for (const k of Object.keys(o)) {
58
+ if (!allowed.includes(k)) {
59
+ return {
60
+ ok: false,
61
+ key: k,
62
+ because: k === 'command' || k === 'teardown'
63
+ ? "a preview command is read only from the project's own .looply/config.yaml (preview.command), never from a remote setting"
64
+ : `is not part of a ${provider} preview`,
65
+ };
66
+ }
67
+ }
68
+ if (provider === 'netlify') {
69
+ const site = o['site'];
70
+ if (site === undefined || site === null || site === '')
71
+ return { ok: true, settings: { provider } };
72
+ if (typeof site !== 'string' || !SITE.test(site))
73
+ return { ok: false, key: 'site', because: 'must be a Netlify site name, e.g. tabsy-web' };
74
+ return { ok: true, settings: { provider, site } };
75
+ }
76
+ if (provider === 'heroku') {
77
+ const pipeline = o['pipeline'];
78
+ if (typeof pipeline !== 'string' || !PIPELINE.test(pipeline)) {
79
+ return { ok: false, key: 'pipeline', because: 'must be a Heroku pipeline name or id, e.g. tabsy-pipeline' };
80
+ }
81
+ const create = o['create'];
82
+ if (create !== undefined && typeof create !== 'boolean')
83
+ return { ok: false, key: 'create', because: 'must be true or false' };
84
+ return { ok: true, settings: create === true ? { provider, pipeline, create: true } : { provider, pipeline } };
85
+ }
86
+ return { ok: true, settings: { provider } };
87
+ }
88
+ /** One sentence a person reads beside the choice. */
89
+ function describePreview(s) {
90
+ if (!s || s.provider === 'none')
91
+ return 'no preview site';
92
+ if (s.provider === 'netlify')
93
+ return `Netlify's deploy preview${s.site ? ` of ${s.site}` : ''} (Netlify builds it; Looply reads the link)`;
94
+ if (s.provider === 'heroku') {
95
+ return `a Heroku review app on ${s.pipeline}${s.create ? ' (Looply asks Heroku for one when the pipeline does not make it)' : " (the pipeline's automatic review apps)"}`;
96
+ }
97
+ return "the preview command the project's .looply/config.yaml declares";
98
+ }
99
+ /**
100
+ * WHERE ONE PULL REQUEST'S PREVIEW STANDS.
101
+ *
102
+ * building — the provider is building it (or Looply's command is running)
103
+ * live — it is up; `url` is the address a person opens
104
+ * failed — it did not build, or never appeared; `detail` says why in words
105
+ * removed — the pull request merged or closed and the preview was torn down
106
+ * (or, where the provider keeps it, is no longer updated — `detail` says)
107
+ */
108
+ exports.PREVIEW_STATES = ['building', 'live', 'failed', 'removed'];
109
+ const MAX_DETAIL = 400;
110
+ const MAX_URL = 400;
111
+ /**
112
+ * A preview address safe to store and show: https only, no user:password, no
113
+ * query string, no fragment. Null for anything else.
114
+ */
115
+ function safePreviewUrl(raw) {
116
+ if (typeof raw !== 'string')
117
+ return null;
118
+ const s = raw.trim();
119
+ if (s === '' || s.length > 2000)
120
+ return null;
121
+ let u;
122
+ try {
123
+ u = new URL(s);
124
+ }
125
+ catch {
126
+ return null;
127
+ }
128
+ if (u.protocol !== 'https:' || u.hostname === '')
129
+ return null;
130
+ const out = `https://${u.host.toLowerCase()}${u.pathname === '/' ? '' : u.pathname}`;
131
+ return out.length > MAX_URL || /\s/.test(out) ? null : out;
132
+ }
133
+ /** A report a machine sent, checked once, the same way on both sides. */
134
+ function validatePreviewReport(x) {
135
+ if (typeof x !== 'object' || x === null || Array.isArray(x))
136
+ return { ok: false, because: 'must be an object' };
137
+ const o = x;
138
+ const provider = o['provider'];
139
+ if (!isPreviewProvider(provider) || provider === 'none')
140
+ return { ok: false, because: 'provider must be netlify, heroku or command' };
141
+ const state = o['state'];
142
+ if (typeof state !== 'string' || !exports.PREVIEW_STATES.includes(state)) {
143
+ return { ok: false, because: `state must be one of: ${exports.PREVIEW_STATES.join(', ')}` };
144
+ }
145
+ let url = null;
146
+ if (o['url'] !== null && o['url'] !== undefined) {
147
+ url = safePreviewUrl(o['url']);
148
+ if (url === null || url !== o['url'])
149
+ return { ok: false, because: 'url must be an https address without credentials, query or fragment' };
150
+ }
151
+ let pullRequestUrl = null;
152
+ if (o['pullRequestUrl'] !== null && o['pullRequestUrl'] !== undefined) {
153
+ const p = o['pullRequestUrl'];
154
+ if (typeof p !== 'string' || p.length > MAX_URL || !/^https:\/\/[^\s]+$/.test(p))
155
+ return { ok: false, because: 'pullRequestUrl must be an https address' };
156
+ pullRequestUrl = p;
157
+ }
158
+ let sha = null;
159
+ if (o['sha'] !== null && o['sha'] !== undefined) {
160
+ if (typeof o['sha'] !== 'string' || !/^[0-9a-f]{7,64}$/.test(o['sha']))
161
+ return { ok: false, because: 'sha must be a hex commit id' };
162
+ sha = o['sha'];
163
+ }
164
+ let detail = null;
165
+ if (o['detail'] !== null && o['detail'] !== undefined) {
166
+ if (typeof o['detail'] !== 'string' || o['detail'].length > MAX_DETAIL)
167
+ return { ok: false, because: `detail must be a string of at most ${MAX_DETAIL} characters` };
168
+ detail = o['detail'];
169
+ }
170
+ if (state === 'live' && url === null)
171
+ return { ok: false, because: 'a live preview needs its url' };
172
+ return { ok: true, report: { provider, state: state, url, pullRequestUrl, sha, detail } };
173
+ }
174
+ //# sourceMappingURL=preview-environment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"preview-environment.js","sourceRoot":"","sources":["../src/preview-environment.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;AAiBH,8CAEC;AAKD,0DAmCC;AAGD,0CAOC;AAkCD,wCAaC;AAGD,sDAgCC;AArJY,QAAA,iBAAiB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAStE,QAAA,wBAAwB,GAAoB,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAE9E,MAAM,IAAI,GAAG,iCAAiC,CAAC;AAC/C,4CAA4C;AAC5C,MAAM,QAAQ,GAAG,yFAAyF,CAAC;AAE3G,SAAgB,iBAAiB,CAAC,CAAU;IAC1C,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAK,yBAAuC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC;AAID,wEAAwE;AACxE,SAAgB,uBAAuB,CAAC,CAAU;IAChD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,kDAAkD,EAAE,CAAC;IACnG,CAAC;IACD,MAAM,CAAC,GAAG,CAA4B,CAAC;IACvC,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;IAC/B,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,mBAAmB,yBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACpI,MAAM,OAAO,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAC1I,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,GAAG,EAAE,CAAC;gBACN,OAAO,EAAE,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,UAAU;oBAC1C,CAAC,CAAC,0HAA0H;oBAC5H,CAAC,CAAC,oBAAoB,QAAQ,UAAU;aAC3C,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QACvB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;QACpG,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,6CAA6C,EAAE,CAAC;QAC5I,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;IACpD,CAAC;IACD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,2DAA2D,EAAE,CAAC;QAC9G,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC3B,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,SAAS;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;QAC/H,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC;IACjH,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAqB,EAAE,CAAC;AACjE,CAAC;AAED,qDAAqD;AACrD,SAAgB,eAAe,CAAC,CAAqC;IACnE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,MAAM;QAAE,OAAO,iBAAiB,CAAC;IAC1D,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,2BAA2B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,6CAA6C,CAAC;IAC3I,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,0BAA0B,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,kEAAkE,CAAC,CAAC,CAAC,yCAAyC,EAAE,CAAC;IAC5K,CAAC;IACD,OAAO,gEAAgE,CAAC;AAC1E,CAAC;AAED;;;;;;;;GAQG;AACU,QAAA,cAAc,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAgBjF,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,MAAM,OAAO,GAAG,GAAG,CAAC;AAEpB;;;GAGG;AACH,SAAgB,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACrB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,GAAG,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7C,IAAI,CAAM,CAAC;IACX,IAAI,CAAC;QACH,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC9D,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrF,OAAO,GAAG,CAAC,MAAM,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;AAC7D,CAAC;AAED,yEAAyE;AACzE,SAAgB,qBAAqB,CAAC,CAAU;IAC9C,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAChH,MAAM,CAAC,GAAG,CAA4B,CAAC;IACvC,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;IAC/B,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,QAAQ,KAAK,MAAM;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,6CAA6C,EAAE,CAAC;IACtI,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;IACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAE,sBAAoC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACxF,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACtF,CAAC;IACD,IAAI,GAAG,GAAkB,IAAI,CAAC;IAC9B,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QAChD,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/B,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,qEAAqE,EAAE,CAAC;IAC7I,CAAC;IACD,IAAI,cAAc,GAAkB,IAAI,CAAC;IACzC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,SAAS,EAAE,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC9B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;QAC3J,cAAc,GAAG,CAAC,CAAC;IACrB,CAAC;IACD,IAAI,GAAG,GAAkB,IAAI,CAAC;IAC9B,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QAChD,IAAI,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;QACrI,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;QACtD,IAAI,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,UAAU;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,sCAAsC,UAAU,aAAa,EAAE,CAAC;QACrK,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,KAAK,MAAM,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;IACpG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAqB,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC;AAC5G,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@looply/core",
3
- "version": "0.5.13",
3
+ "version": "0.5.17",
4
4
  "description": "Shared event schema, state machines and ledger projection for looply",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",