@twotaps/site-utils-base 0.0.1

package/README.md

@@ -0,0 +1,27 @@
+# site-utils
+
+The site-utils package contains utility code and components for building public-facing websites using Two Taps 2.0. It is available via npm at https://www.npmjs.com/package/@twotaps/site-utils for internal website use or for customers/partners.
+
+## Publish
+---
+To publish the site-utils package on npm, you need an npm account. If you don't have one, create an account at https://www.npmjs.com/signup.
+
+You also need permission from the Two Taps 2.0 admin to publish the site-utils package. Contact the Two Taps 2.0 admin to obtain the necessary permissions.
+
+Once you have the required permissions, run the following command:
+
+```
+yarn publish
+```
+Provide the new version, npm username, email, and password.
+
+Since site-utils is currently being used internally by the snap-fitness repository https://github.com/ltnetwork/snap-fitness-nextjs, that project needs to be updated to ensure the latest changes are available.
+
+In that repository, in `package.json` file update to the latest version:
+```
+"@twotaps/site-utils": "^0.1.xx",
+```
+Still in that project, update the project dependencies: 
+```
+yarn install
+```

package/dist/cli/generate-sdl.d.ts

@@ -0,0 +1,14 @@
+import type { CommandModule } from 'yargs';
+export declare class GenerateSDL implements CommandModule {
+    command: string;
+    describe: string;
+    /**
+     * @inheritDoc
+     */
+    handler(args: {
+        [argName: string]: unknown;
+        _: (string | number)[];
+        $0: string;
+    }): Promise<void>;
+}
+export default GenerateSDL;

package/dist/cli/generate-sdl.js

@@ -0,0 +1,35 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import axios from 'axios';
+import * as fs from 'fs';
+import * as path from 'path';
+import yaml from 'yml';
+export class GenerateSDL {
+    constructor() {
+        this.command = 'generate:sdl';
+        this.describe = 'Get schema from API';
+    }
+    /**
+     * @inheritDoc
+     */
+    // eslint-disable-next-line class-methods-use-this
+    async handler(args) {
+        try {
+            const configPath = path.resolve(process.cwd(), 'config.yml');
+            const configContent = fs.readFileSync(configPath, {
+                encoding: 'utf-8',
+            });
+            const config = yaml.parse(configContent);
+            const response = await axios.get(config.SchemaBuilderURI);
+            fs.writeFile('schema.gql', response.data, (err) => {
+                if (err)
+                    throw err;
+            });
+        }
+        catch (err) {
+            console.error('Unable to retrieve schema: ', err.message);
+            process.exit(1); // Exit with error code 1 so that codegen is not executed
+        }
+    }
+}
+export default GenerateSDL;
+//# sourceMappingURL=generate-sdl.js.map

package/dist/cli/generate-sdl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-sdl.js","sourceRoot":"","sources":["../../src/cli/generate-sdl.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,IAAI,MAAM,KAAK,CAAC;AAQvB,MAAM,OAAO,WAAW;IAAxB;QACE,YAAO,GAAG,cAAc,CAAC;QAEzB,aAAQ,GAAG,qBAAqB,CAAC;IAsBnC,CAAC;IApBC;;OAEG;IACH,kDAAkD;IAClD,KAAK,CAAC,OAAO,CAAC,IAAwE;QACpF,IAAI;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;YAC7D,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE;gBAChD,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAC;YACH,MAAM,MAAM,GAAiB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAC1D,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAChD,IAAI,GAAG;oBAAE,MAAM,GAAG,CAAC;YACrB,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,yDAAyD;SAC3E;IACH,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './page/index.js';
+export * from './util.js';
+export * from './types.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './page/index.js';
+export * from './util.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/page/index.d.ts

@@ -0,0 +1,2 @@
+export * from './page.dto.js';
+export * from './page.service.js';

package/dist/page/index.js

@@ -0,0 +1,3 @@
+export * from './page.dto.js';
+export * from './page.service.js';
+//# sourceMappingURL=index.js.map

package/dist/page/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/page/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}

package/dist/page/page.dto.d.ts

@@ -0,0 +1,64 @@
+export declare class AssetDto {
+    id: number;
+    url: string;
+    altText: string;
+    accessLevel: number;
+}
+export declare class SiteDto {
+    id?: number;
+    customScriptHead: string;
+    customScriptBody: string;
+}
+export declare class Breadcrumb {
+    urlPath: string;
+    name: string;
+}
+export declare class PageDto {
+    id: number;
+    urlSegment: string;
+    name: string;
+    lang: string;
+    brandId: number;
+    properties: {};
+    allowCrawling: boolean;
+    site: SiteDto;
+    sitePath?: string;
+    metaTitle: string;
+    metaDescription: string;
+    ttschema: TTSchemaCustomDto[];
+    breadcrumbs: Breadcrumb[];
+}
+export declare class PageRevisionDto {
+    id: number;
+    schema: any;
+}
+export declare class PageRevisionSchemaDto {
+    id: number;
+    sortOrder: number;
+    properties: TTSchemaProperties[] | null;
+    ttschema: TTSchemaDto | null;
+}
+export declare class PageRevisionSchemaPropertyDto {
+    fieldId: number;
+    name: string;
+    value: string[];
+}
+export declare class TTSchemaDto {
+    id?: number;
+    titleSingular?: string;
+    titlePlural?: string;
+    properties: TTSchemaProperties[];
+}
+export declare class TTSchemaProperties {
+    fieldId: number;
+    name: string;
+    value: string[];
+}
+export declare class TTSchemaCustomDto extends TTSchemaDto {
+    sortOrder: number;
+    name: string;
+    anchorId?: string;
+    anchorOnly: boolean;
+    campaign?: boolean;
+    label?: string;
+}

package/dist/page/page.dto.js

@@ -0,0 +1,21 @@
+export class AssetDto {
+}
+export class SiteDto {
+}
+export class Breadcrumb {
+}
+export class PageDto {
+}
+export class PageRevisionDto {
+}
+export class PageRevisionSchemaDto {
+}
+export class PageRevisionSchemaPropertyDto {
+}
+export class TTSchemaDto {
+}
+export class TTSchemaProperties {
+}
+export class TTSchemaCustomDto extends TTSchemaDto {
+}
+//# sourceMappingURL=page.dto.js.map

package/dist/page/page.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.dto.js","sourceRoot":"","sources":["../../src/page/page.dto.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,QAAQ;CAQpB;AAED,MAAM,OAAO,OAAO;CAMnB;AAED,MAAM,OAAO,UAAU;CAItB;AAED,MAAM,OAAO,OAAO;CA0BnB;AAED,MAAM,OAAO,eAAe;CAI3B;AAED,MAAM,OAAO,qBAAqB;CAQjC;AAED,MAAM,OAAO,6BAA6B;CAMzC;AAED,MAAM,OAAO,WAAW;CAQvB;AAED,MAAM,OAAO,kBAAkB;CAM9B;AAED,MAAM,OAAO,iBAAkB,SAAQ,WAAW;CAYjD"}

package/dist/page/page.query.d.ts

@@ -0,0 +1,8 @@
+export declare const DynamicPageFiltering: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_PAGE: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_ERROR_TEMPLATE: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_URL_RESOLUTION: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_LAYOUT_REVISION: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_ASSETS: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_DOMAIN_SITEMAP: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;
+export declare const GET_DOMAIN_ROBOTS: import("@urql/core/dist/urql-core-chunk").TypedDocumentNode<any, import("@urql/core/dist/urql-core-chunk").AnyVariables>;

package/dist/page/page.query.js

@@ -0,0 +1,216 @@
+import { gql } from '@urql/core';
+export const DynamicPageFiltering = gql `
+  query DynamicPageFiltering(
+    $latitude: Float
+    $longitude: Float
+    $pageType: String!
+    $domain: String!
+    $limitPageId: [Int]
+    $query: String
+    $radius: Float
+    $limit: Int
+    $offset: Int
+    $filters: JSONObject
+    $fields: [String]
+  ) {
+    publicListPages(
+      latitude: $latitude
+      longitude: $longitude
+      pageType: $pageType
+      domain: $domain
+      limitPageId: $limitPageId
+      query: $query
+      radius: $radius
+      limit: $limit
+      offset: $offset
+      filters: $filters
+      fields: $fields
+    ) {
+      items {
+        id
+        name
+        metaTitle
+        metaDescription
+        allowCrawling
+        customProperties
+        urlPath
+      }
+      total
+    }
+  }
+`;
+const REVISION_SCHEMA_FRAGMENT = gql `
+  fragment revisionSchemaFragment on PageRevisionSchemaEntityDto {
+    id
+    sortOrder
+    anchorId
+    campaign
+    label
+    properties {
+      fieldId
+      name
+      value
+    }
+    ttschema(draftMode: $draftMode) {
+      id
+      name
+      titlePlural
+      titleSingular
+      type
+      fields {
+        id
+        name
+        type
+        hasMultipleValues
+        typeTTSchema {
+          id
+        }
+      }
+      subSchemas {
+        id
+        name
+        titlePlural
+        titleSingular
+        fields {
+          id
+          name
+          type
+          hasMultipleValues
+          typeTTSchema {
+            id
+          }
+        }
+      }
+    }
+  }
+`;
+const REVISION_FRAGMENT = gql `
+  fragment revisionFragment on PageRevisionEntityDto {
+    id
+    schema(draftMode: $draftMode) {
+      ...revisionSchemaFragment
+      template {
+        id
+        name
+        publishedRevision {
+          id
+          schema {
+            ...revisionSchemaFragment
+          }
+        }
+      }
+    }
+  }
+  ${REVISION_SCHEMA_FRAGMENT}
+`;
+const PAGE_FRAGMENT = gql `
+  fragment pageFragment on PageEntityDto {
+    id
+    name
+    urlSegment
+    metaTitle
+    metaDescription
+    allowCrawling
+    lang
+    brandId
+    sitePath
+    site {
+      id
+      name
+      customScriptHead
+      customScriptBody
+    }
+    breadcrumbs {
+      name
+      urlPath
+    }
+  }
+`;
+export const GET_PAGE = gql `
+  query Page(
+    $slug: String
+    $domain: String
+    $id: Int
+    $campaignId: Int
+    $draftMode: Boolean = false
+  ) {
+    page(slug: $slug, domain: $domain, id: $id, campaignId: $campaignId) {
+      ...pageFragment
+      publishedRevision {
+        ...revisionFragment
+      }
+    }
+  }
+  ${REVISION_FRAGMENT}
+  ${PAGE_FRAGMENT}
+`;
+export const GET_ERROR_TEMPLATE = gql `
+  query ErrorTemplate(
+    $domain: String!
+    $path: String!
+    $errorType: ErrorTemplateType!
+    $draftMode: Boolean = false
+  ) {
+    errorTemplate(domain: $domain, path: $path, errorType: $errorType) {
+      publishedRevision {
+        ...revisionFragment
+      }
+    }
+  }
+  ${REVISION_FRAGMENT}
+`;
+export const GET_URL_RESOLUTION = gql `
+  query UrlResolution($slug: String, $domain: String!, $draftMode: Boolean = false) {
+    urlResolution(slug: $slug, domain: $domain) {
+      page {
+        ...pageFragment
+        publishedRevision {
+          ...revisionFragment
+        }
+      }
+      redirect {
+        target
+        type
+      }
+    }
+  }
+  ${REVISION_FRAGMENT}
+  ${PAGE_FRAGMENT}
+`;
+export const GET_LAYOUT_REVISION = gql `
+  query LayoutRevision($id: Int!, $draftMode: Boolean = true, $campaignId: Int, $pageId: Int) {
+    pageRevision(id: $id, campaignId: $campaignId, pageId: $pageId) {
+      ...revisionFragment
+      page {
+        ...pageFragment
+      }
+    }
+  }
+  ${REVISION_FRAGMENT}
+  ${PAGE_FRAGMENT}
+`;
+export const GET_ASSETS = gql `
+  query AssetList($ids: [Int!]!) {
+    assetList(ids: $ids) {
+      id
+      url
+      altText
+      accessLevel
+    }
+  }
+`;
+export const GET_DOMAIN_SITEMAP = gql `
+  query DomainWithSitemap($domain: String!) {
+    domain(domain: $domain) {
+      sitemap
+    }
+  }
+`;
+export const GET_DOMAIN_ROBOTS = gql `
+  query DomainWithRobot($domain: String!) {
+    domain(domain: $domain) {
+      robots
+    }
+  }
+`;
+//# sourceMappingURL=page.query.js.map

package/dist/page/page.query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.query.js","sourceRoot":"","sources":["../../src/page/page.query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCtC,CAAC;AAEF,MAAM,wBAAwB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CnC,CAAC;AAEF,MAAM,iBAAiB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;IAiBzB,wBAAwB;CAC3B,CAAC;AAEF,MAAM,aAAa,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;CAsBxB,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;IAevB,iBAAiB;IACjB,aAAa;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;;;;;;;;;;;;;IAajC,iBAAiB;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;IAejC,iBAAiB;IACjB,aAAa;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAA;;;;;;;;;IASlC,iBAAiB;IACjB,aAAa;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,CAAA;;;;;;;;;CAS5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;;;;;;CAMpC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAA;;;;;;CAMnC,CAAC"}

package/dist/page/page.service.d.ts

@@ -0,0 +1,50 @@
+import { ErrorTemplateType } from '../types.js';
+export declare class PageService {
+    private readonly apolloClient;
+    private readonly config;
+    constructor(uri: string | undefined);
+    getPage(slug: string, domain?: string): Promise<any>;
+    getPagePreview(id: number, campaignId?: number, draftMode?: boolean): Promise<any>;
+    resolveUrl(slug: string, domain?: string): Promise<any>;
+    getErrorTemplate(domain: string, path: string, errorType: ErrorTemplateType): Promise<any>;
+    getRevision(id: number, pageId?: string, campaignId?: string, draftMode?: boolean): Promise<{
+        props: {
+            page: {
+                id: number;
+                metaTitle: string;
+                properties: {};
+                ttschema: import("./page.dto.js").TTSchemaCustomDto[];
+                __typename?: "PageEntityDto";
+                name: string;
+                urlSegment: string;
+                metaDescription?: string;
+                allowCrawling?: boolean;
+                lang: string;
+                brandId: number;
+                sitePath?: string;
+                site: {
+                    __typename?: "SiteEntityDto";
+                    id: number;
+                    customScriptHead: string;
+                    customScriptBody: string;
+                };
+            };
+        };
+        notFound?: undefined;
+    } | {
+        props: {
+            page: {
+                id: number;
+                metaTitle: string;
+                properties: {};
+                ttschema: any[];
+            };
+        };
+        notFound?: undefined;
+    } | {
+        notFound: boolean;
+        props?: undefined;
+    }>;
+    getSitemap(domain: string): Promise<any>;
+    getRobots(domain: string): Promise<any>;
+}