altair-static 6.4.2 → 7.0.0

package/build/index.d.ts

@@ -25,7 +25,7 @@ declare const HTTP_VERBS: readonly [
 	"PUT",
 	"DELETE"
 ];
-export type HttpVerb = typeof HTTP_VERBS[number];
+export type HttpVerb = (typeof HTTP_VERBS)[number];
 declare const theme: {
 	easing: string;
 	colors: {
@@ -303,6 +303,10 @@ export interface AltairConfigOptions extends AltairWindowOptions {
 	 * List of options for windows to be loaded
 	 */
 	initialWindows?: AltairWindowOptions[];
+	/**
+	 * Persisted settings for the app. The settings will be merged with the app settings.
+	 */
+	persistedSettings?: Partial<SettingsState>;
 	/**
 	 * Disable the account and remote syncing functionality
 	 */
@@ -354,6 +358,7 @@ declare class AltairConfig {
 		postRequestScript: string;
 		instanceStorageNamespace: string;
 		settings: Partial<SettingsState> | undefined;
+		persistedSettings: Partial<SettingsState> | undefined;
 		initialSubscriptionsProvider: SubscriptionProviderIds | undefined;
 		initialSubscriptionsPayload: IDictionary;
 		initialHttpMethod: "POST" | "GET" | "PUT" | "DELETE";
@@ -361,7 +366,7 @@ declare class AltairConfig {
 		windows: AltairWindowOptions[];
 		disableAccount: boolean;
 	};
-	constructor({ endpointURL, subscriptionsEndpoint, subscriptionsProtocol, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript, instanceStorageNamespace, initialSettings, initialSubscriptionsProvider, initialSubscriptionsPayload, initialHttpMethod, preserveState, initialWindows, disableAccount, }?: AltairConfigOptions);
+	constructor({ endpointURL, subscriptionsEndpoint, subscriptionsProtocol, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript, instanceStorageNamespace, initialSettings, persistedSettings, initialSubscriptionsProvider, initialSubscriptionsPayload, initialHttpMethod, preserveState, initialWindows, disableAccount, }?: AltairConfigOptions);
 }
 /**
  * Returns the path to Altair assets, for resolving the assets when rendering Altair

package/build/index.js

@@ -61,7 +61,8 @@ var renderInitialOptions = (options = {}) => {
     "preserveState",
     "initialHttpMethod",
     "initialWindows",
-    "disableAccount"
+    "disableAccount",
+    "persistedSettings"
   ])});
     `;
 };
@@ -70,9 +71,9 @@ var renderAltair = (options = {}) => {
   const initialOptions = renderInitialOptions(options);
   const baseURL = options.baseURL || "./";
   if (options.serveInitialOptionsInSeperateRequest) {
-    return altairHtml.replace(/<base.*>/, `<base href="${baseURL}">`).replace("</body>", `<script src="initial_options.js"><\/script></body>`);
+    return altairHtml.replace(/<base.*>/, `<base href="${baseURL}">`).replace("</body>", () => `<script src="initial_options.js"><\/script></body>`);
   } else {
-    return altairHtml.replace(/<base.*>/, `<base href="${baseURL}">`).replace("</body>", `<script>${initialOptions}<\/script></body>`);
+    return altairHtml.replace(/<base.*>/, `<base href="${baseURL}">`).replace("</body>", () => `<script>${initialOptions}<\/script></body>`);
   }
 };
 var getRenderedAltairOpts = (renderOptions, keys) => {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "altair-static",
   "description": "Static package for altair graphql client",
-  "version": "6.4.2",
+  "version": "7.0.0",
   "author": "Samuel Imolorhe <altair@sirmuel.design> (https://sirmuel.design)",
   "bugs": "https://github.com/altair-graphql/altair/issues",
   "devDependencies": {
-    "@altairgraphql/app": "^6.4.2",
+    "@altairgraphql/app": "^7.0.0",
     "@types/jest": "^24.0.23",
-    "altair-graphql-core": "^6.4.2",
+    "altair-graphql-core": "^7.0.0",
     "dts-bundle-generator": "^6.11.0",
     "esbuild": "^0.14.43",
     "jest": "29.4.1",
@@ -21,7 +21,7 @@
     "type": "opencollective",
     "url": "https://opencollective.com/altair"
   },
-  "gitHead": "7220567f89113b05e8d6b32985cc14b06e24a6f2",
+  "gitHead": "bbfda6e08adc351fecdccb7f1bf19738e9880387",
   "homepage": "https://github.com/altair-graphql/altair#readme",
   "keywords": [
     "altair",

package/src/__snapshots__/index.test.ts.snap

@@ -64,6 +64,80 @@ initialVariables: \`{ variable: 1 }\`,
 "
 `;
 
+exports[`renderAltair should return expected string with $$ 1`] = `
+"<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Altair</title>
+    <base href="/">
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+    <link href="[% STYLES_FILE %]" rel="stylesheet" />
+  </head>
+
+  <body>
+    <app-root>
+      <style>
+        .loading-screen {
+          /*Prevents the loading screen from showing until CSS is downloaded*/
+          display: none;
+        }
+      </style>
+      <div class="loading-screen styled">
+        <div class="loading-screen-inner">
+          <div class="loading-screen-logo-container">
+            <img src="assets/img/logo_350.svg" alt="Altair" />
+          </div>
+          <div class="loading-screen-loading-indicator">
+            <span class="loading-indicator-dot"></span>
+            <span class="loading-indicator-dot"></span>
+            <span class="loading-indicator-dot"></span>
+          </div>
+        </div>
+      </div>
+    </app-root>
+    <script
+      rel="preload"
+      as="script"
+      type="text/javascript"
+      src="[% RUNTIME_SCRIPT %]"
+    ></script>
+    <script
+      rel="preload"
+      as="script"
+      type="text/javascript"
+      src="[% POLYFILLS_SCRIPT %]"
+    ></script>
+    <script
+      rel="preload"
+      as="script"
+      type="text/javascript"
+      src="[% MAIN_SCRIPT %]"
+    ></script>
+  <script>
+        AltairGraphQL.init({
+initialQuery: \`{
+          MyDomains (
+            page: {start: 1, limit: 1000}
+            where: {AND: [{AND: [{myFilterA: {EQ: "$$"}} {myFilterB: {EQ: "2099-12-31T00:00:00Z"}}, {myFilterC: {EQ: "2024-04-23"}}]}]}
+          ) {
+            pages
+            total
+            select {
+             myField1
+             myField2     
+            }
+          }
+        }\`,
+endpointURL: \`https://example.com/graphql\`,
+initialVariables: \`{ variable: 1 }\`,
+});
+    </script></body>
+</html>
+"
+`;
+
 exports[`renderInitialOptions should return expected string 1`] = `
 "
         AltairGraphQL.init({
@@ -73,6 +147,31 @@ initialQuery: \`query {
 endpointURL: \`https://example.com/graphql\`,
 initialHeaders: {"X-GraphQL-Token":"asd7-237s-2bdk-nsdk4"},
 initialSettings: {"theme":"dark"},
+persistedSettings: {"theme":"light"},
+});
+    "
+`;
+
+exports[`renderInitialOptions should return expected string with $$ 1`] = `
+"
+        AltairGraphQL.init({
+initialQuery: \`{
+        MyDomains (
+          page: {start: 1, limit: 1000}
+          where: {AND: [{AND: [{myFilterA: {EQ: "$$"}} {myFilterB: {EQ: "2099-12-31T00:00:00Z"}}, {myFilterC: {EQ: "2024-04-23"}}]}]}
+        ) {
+          pages
+          total
+          select {
+           myField1
+           myField2     
+          }
+        }
+      }\`,
+endpointURL: \`https://example.com/graphql\`,
+initialHeaders: {"X-GraphQL-Token":"asd7-237s-2bdk-nsdk4"},
+initialSettings: {"theme":"dark"},
+persistedSettings: {"theme":"light"},
 });
     "
 `;

package/src/index.test.ts

@@ -27,6 +27,9 @@ describe('renderInitialOptions', () => {
       initialSettings: {
         theme: 'dark',
       },
+      persistedSettings: {
+        theme: 'light',
+      },
     });
 
     expect(translateRenderedStrToObj(result)).toEqual({
@@ -40,6 +43,65 @@ describe('renderInitialOptions', () => {
       initialSettings: {
         theme: 'dark',
       },
+      persistedSettings: {
+        theme: 'light',
+      },
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+  it('should return expected string with $$', () => {
+    const result = renderInitialOptions({
+      baseURL: '/',
+      initialQuery: `{
+        MyDomains (
+          page: {start: 1, limit: 1000}
+          where: {AND: [{AND: [{myFilterA: {EQ: "$$"}} {myFilterB: {EQ: "2099-12-31T00:00:00Z"}}, {myFilterC: {EQ: "2024-04-23"}}]}]}
+        ) {
+          pages
+          total
+          select {
+           myField1
+           myField2     
+          }
+        }
+      }`,
+      endpointURL: 'https://example.com/graphql',
+      initialHeaders: {
+        'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4',
+      },
+      initialSettings: {
+        theme: 'dark',
+      },
+      persistedSettings: {
+        theme: 'light',
+      },
+    });
+
+    expect(translateRenderedStrToObj(result)).toEqual({
+      initialQuery: `{
+        MyDomains (
+          page: {start: 1, limit: 1000}
+          where: {AND: [{AND: [{myFilterA: {EQ: "$$"}} {myFilterB: {EQ: "2099-12-31T00:00:00Z"}}, {myFilterC: {EQ: "2024-04-23"}}]}]}
+        ) {
+          pages
+          total
+          select {
+           myField1
+           myField2     
+          }
+        }
+      }`,
+      endpointURL: 'https://example.com/graphql',
+      initialHeaders: {
+        'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4',
+      },
+      initialSettings: {
+        theme: 'dark',
+      },
+      persistedSettings: {
+        theme: 'light',
+      },
     });
 
     expect(result).toMatchSnapshot();
@@ -72,4 +134,30 @@ describe('renderAltair', () => {
       })
     ).toMatchSnapshot();
   });
+  it('should return expected string with $$', () => {
+    (getAltairHtml as any).default = jest.fn();
+    (getAltairHtml as any).default.mockReturnValue(
+      readFileSync(resolve(__dirname, 'index.html'), 'utf8')
+    );
+    expect(
+      renderAltair({
+        baseURL: '/',
+        initialQuery: `{
+          MyDomains (
+            page: {start: 1, limit: 1000}
+            where: {AND: [{AND: [{myFilterA: {EQ: "$$"}} {myFilterB: {EQ: "2099-12-31T00:00:00Z"}}, {myFilterC: {EQ: "2024-04-23"}}]}]}
+          ) {
+            pages
+            total
+            select {
+             myField1
+             myField2     
+            }
+          }
+        }`,
+        endpointURL: 'https://example.com/graphql',
+        initialVariables: '{ variable: 1 }',
+      })
+    ).toMatchSnapshot();
+  });
 });

package/src/index.ts

@@ -39,6 +39,7 @@ export const renderInitialOptions = (options: RenderOptions = {}) => {
           'initialHttpMethod',
           'initialWindows',
           'disableAccount',
+          'persistedSettings',
         ])});
     `;
 };
@@ -54,11 +55,11 @@ export const renderAltair = (options: RenderOptions = {}) => {
   if (options.serveInitialOptionsInSeperateRequest) {
     return altairHtml
       .replace(/<base.*>/, `<base href="${baseURL}">`)
-      .replace('</body>', `<script src="initial_options.js"></script></body>`);
+      .replace('</body>', () => `<script src="initial_options.js"></script></body>`);
   } else {
     return altairHtml
       .replace(/<base.*>/, `<base href="${baseURL}">`)
-      .replace('</body>', `<script>${initialOptions}</script></body>`);
+      .replace('</body>', () => `<script>${initialOptions}</script></body>`);
   }
 };
 

package/build/dist/671.js

@@ -1,5 +0,0 @@
-
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="b0148898-57e2-5b67-a09d-ebbb00e5d6f2")}catch(e){}}();
-(()=>{"use strict";var __webpack_modules__={91671:(__unused_webpack_module,__unused_webpack___webpack_exports__,__webpack_require__)=>{var _home_runner_work_altair_altair_node_modules_angular_devkit_build_angular_node_modules_babel_runtime_helpers_esm_asyncToGenerator_js__WEBPACK_IMPORTED_MODULE_1__=__webpack_require__(26642),uuid__WEBPACK_IMPORTED_MODULE_3__=__webpack_require__(37653),_events__WEBPACK_IMPORTED_MODULE_2__=__webpack_require__(88772),_helpers__WEBPACK_IMPORTED_MODULE_0__=__webpack_require__(42243);onmessage=function(){var e=(0,_home_runner_work_altair_altair_node_modules_angular_devkit_build_angular_node_modules_babel_runtime_helpers_esm_asyncToGenerator_js__WEBPACK_IMPORTED_MODULE_1__.Z)(function*(t){if(t.data.type===_events__WEBPACK_IMPORTED_MODULE_2__.Jk)try{yield initExecute(t.data.payload)}catch(_){makeCall("scriptError",_)}});return function(_){return e.apply(this,arguments)}}();const workerHandlerNames=["setCookie","request","getStorageItem","setStorageItem"],initExecute=function(){var _ref2=(0,_home_runner_work_altair_altair_node_modules_angular_devkit_build_angular_node_modules_babel_runtime_helpers_esm_asyncToGenerator_js__WEBPACK_IMPORTED_MODULE_1__.Z)(function*(payload){const[script,data]=payload,res=yield new Promise((resolve,reject)=>{self.addEventListener("unhandledrejection",e=>(e.preventDefault(),reject(e.reason)));const clonedMutableData=JSON.parse(JSON.stringify(data)),handlers=workerHandlerNames.reduce((e,t)=>(e[t]=(..._)=>makeCall(t,..._),e),{}),context={altair:(0,_helpers__WEBPACK_IMPORTED_MODULE_0__.IL)(clonedMutableData,handlers),alert},contextEntries=Object.entries(context);try{const res=function(){return eval(`\n          (async(${contextEntries.map(e=>e[0]).join(",")}) => {\n            ${script};\n            return altair.data;\n          })(...this.__ctxE.map(e => e[1]));\n        `)}.call({__ctxE:contextEntries});return resolve(res)}catch(e){return reject(e)}});res.__toSetActiveEnvironment&&makeCall("updateActiveEnvironment",res.__toSetActiveEnvironment),makeCall("executeComplete",res)});return function e(t){return _ref2.apply(this,arguments)}}(),alert=e=>makeCall("alert",e),makeCall=(e,...t)=>new Promise((_,r)=>{const n=(0,uuid__WEBPACK_IMPORTED_MODULE_3__.Z)(),i={type:e,payload:{id:n,args:t}};addEventListener("message",c=>{switch(c.data.type){case`${e}_response`:return c.data.payload.id!==n?void 0:_(c.data.payload.response);case`${e}_error`:return c.data.payload.id!==n?void 0:r(c.data.payload.error)}}),self.postMessage(i)})},88772:(e,t,_)=>{_.d(t,{Jk:()=>r});const r="init_execute"},42243:(e,t,_)=>{_.d(t,{IL:()=>a});var r=_(26642),n=function(o){return o.INTROSPECTION="introspection",o.QUERY="query",o.SUBSCRIPTION="subscription",o}(n||{});const i={atob:{exec:()=>(0,r.Z)(function*(){return(yield _.e(857).then(_.t.bind(_,4857,23))).atob})()},btoa:{exec:()=>(0,r.Z)(function*(){return(yield _.e(857).then(_.t.bind(_,4857,23))).btoa})()},"crypto-js":{exec:()=>(0,r.Z)(function*(){return(yield _.e(658).then(_.t.bind(_,39658,23))).default})()}},c=o=>{if(o.response)return{body:o.response.response.body,requestType:o.requestType||n.QUERY,responseTime:o.response.meta.responseTime,statusCode:o.response.response.status,headers:o.response.meta.headers}},u=function(){var o=(0,r.Z)(function*(l){const s=i[l];if(!s)throw new Error(`No request script module found matching "${l}"`);return s.exec()});return function(s){return o.apply(this,arguments)}}(),a=(o,l)=>{return{data:o,helpers:{getEnvironment:s=>o.environment[s],setEnvironment:(s,p,d=!1)=>{o.environment[s]=p,d&&(o.__toSetActiveEnvironment=o.__toSetActiveEnvironment??{},o.__toSetActiveEnvironment[s]=p)},getCookie:s=>o.__cookieJar?.[s]??"",setCookie:(s,p,d)=>{l.setCookie(s,p,d)},request:(s=(0,r.Z)(function*(p,d,b){return l.request(p,d,b)}),function(d,b,m){return s.apply(this,arguments)})},storage:{get:s=>l.getStorageItem(s),set:(s,p)=>l.setStorageItem(s,p)},importModule:s=>u(s),response:c(o),log:s=>{o.requestScriptLogs=o.requestScriptLogs??[],o.requestScriptLogs.push({time:Date.now(),text:JSON.stringify(s,null,2),source:"Request script"})}};var s}},69053:(e,t,_)=>{_.d(t,{Z:()=>n});const n={randomUUID:typeof crypto<"u"&&crypto.randomUUID&&crypto.randomUUID.bind(crypto)}},16996:(e,t,_)=>{let r;_.d(t,{Z:()=>i});const n=new Uint8Array(16);function i(){if(!r&&(r=typeof crypto<"u"&&crypto.getRandomValues&&crypto.getRandomValues.bind(crypto),!r))throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");return r(n)}},59313:(e,t,_)=>{_.d(t,{S:()=>n});const r=[];for(let u=0;u<256;++u)r.push((u+256).toString(16).slice(1));function n(u,a=0){return r[u[a+0]]+r[u[a+1]]+r[u[a+2]]+r[u[a+3]]+"-"+r[u[a+4]]+r[u[a+5]]+"-"+r[u[a+6]]+r[u[a+7]]+"-"+r[u[a+8]]+r[u[a+9]]+"-"+r[u[a+10]]+r[u[a+11]]+r[u[a+12]]+r[u[a+13]]+r[u[a+14]]+r[u[a+15]]}},37653:(e,t,_)=>{_.d(t,{Z:()=>u});var r=_(69053),n=_(16996),i=_(59313);const u=function c(a,o,l){if(r.Z.randomUUID&&!o&&!a)return r.Z.randomUUID();const s=(a=a||{}).random||(a.rng||n.Z)();if(s[6]=15&s[6]|64,s[8]=63&s[8]|128,o){l=l||0;for(let p=0;p<16;++p)o[l+p]=s[p];return o}return(0,i.S)(s)}}},__webpack_module_cache__={},e;function __webpack_require__(e){var t=__webpack_module_cache__[e];if(void 0!==t)return t.exports;var _=__webpack_module_cache__[e]={exports:{}};return __webpack_modules__[e].call(_.exports,_,_.exports,__webpack_require__),_.exports}__webpack_require__.m=__webpack_modules__,__webpack_require__.x=()=>{var e=__webpack_require__.O(void 0,[592],()=>__webpack_require__(91671));return __webpack_require__.O(e)},e=[],__webpack_require__.O=(t,_,r,n)=>{if(!_){var c=1/0;for(i=0;i<e.length;i++){for(var[_,r,n]=e[i],u=!0,a=0;a<_.length;a++)(!1&n||c>=n)&&Object.keys(__webpack_require__.O).every(b=>__webpack_require__.O[b](_[a]))?_.splice(a--,1):(u=!1,n<c&&(c=n));if(u){e.splice(i--,1);var o=r();void 0!==o&&(t=o)}}return t}n=n||0;for(var i=e.length;i>0&&e[i-1][2]>n;i--)e[i]=e[i-1];e[i]=[_,r,n]},(()=>{var t,e=Object.getPrototypeOf?_=>Object.getPrototypeOf(_):_=>_.__proto__;__webpack_require__.t=function(_,r){if(1&r&&(_=this(_)),8&r||"object"==typeof _&&_&&(4&r&&_.__esModule||16&r&&"function"==typeof _.then))return _;var n=Object.create(null);__webpack_require__.r(n);var i={};t=t||[null,e({}),e([]),e(e)];for(var c=2&r&&_;"object"==typeof c&&!~t.indexOf(c);c=e(c))Object.getOwnPropertyNames(c).forEach(u=>i[u]=()=>_[u]);return i.default=()=>_,__webpack_require__.d(n,i),n}})(),__webpack_require__.d=(e,t)=>{for(var _ in t)__webpack_require__.o(t,_)&&!__webpack_require__.o(e,_)&&Object.defineProperty(e,_,{enumerable:!0,get:t[_]})},__webpack_require__.f={},__webpack_require__.e=e=>Promise.all(Object.keys(__webpack_require__.f).reduce((t,_)=>(__webpack_require__.f[_](e,t),t),[])),__webpack_require__.u=e=>(592===e?"common":e)+".js",__webpack_require__.miniCssF=e=>{},__webpack_require__.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),__webpack_require__.r=e=>{typeof Symbol<"u"&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},__webpack_require__.j=671,(()=>{var e;__webpack_require__.tt=()=>(void 0===e&&(e={createScriptURL:t=>t},typeof trustedTypes<"u"&&trustedTypes.createPolicy&&(e=trustedTypes.createPolicy("angular#bundler",e))),e)})(),__webpack_require__.tu=e=>__webpack_require__.tt().createScriptURL(e),__webpack_require__.p="",(()=>{var e={671:1};__webpack_require__.f.i=(n,i)=>{e[n]||importScripts(__webpack_require__.tu(__webpack_require__.p+__webpack_require__.u(n)))};var _=self.webpackChunkaltair=self.webpackChunkaltair||[],r=_.push.bind(_);_.push=n=>{var[i,c,u]=n;for(var a in c)__webpack_require__.o(c,a)&&(__webpack_require__.m[a]=c[a]);for(u&&u(__webpack_require__);i.length;)e[i.pop()]=1;r(n)}})(),(()=>{var e=__webpack_require__.x;__webpack_require__.x=()=>__webpack_require__.e(592).then(e)})();var __webpack_exports__=__webpack_require__.x()})();
-//# sourceMappingURL=671.js.map
-//# debugId=b0148898-57e2-5b67-a09d-ebbb00e5d6f2