@8ms/helpers 2.3.5 → 2.3.7

package/dist/lumar/graphql/server/index.d.mts

@@ -0,0 +1,308 @@
+import { f as ApiResponseClass } from "../../../index-B20FTOvk.mjs";
+
+//#region src/lumar/graphql/server/lumarGraphql.d.ts
+declare const operand: {
+  readonly CONTAINS: "contains";
+  readonly DOESNT_CONTAIN: "notContains";
+  readonly DOESNT_MATCH_REGEX: "notMatchesRegex";
+  readonly ENDS_WITH: "endsWith";
+  readonly EQUALS: "eq";
+  readonly GREATER_THAN: "gt";
+  readonly GREATER_THAN_OR_EQUAL: "ge";
+  readonly IS_EMPTY: "isEmpty";
+  readonly LESS_THAN: "lt";
+  readonly LESS_THAN_OR_EQUAL: "le";
+  readonly MATCHES_REGEX: "matchesRegex";
+  readonly NOT_EQUALS: "ne";
+  readonly STARTS_WITH: "beginsWith";
+};
+type Operand = typeof operand[keyof typeof operand];
+declare const reportType: {
+  readonly ADDED: "Added";
+  readonly BASIC: "Basic";
+  readonly MISSING: "Missing";
+  readonly REMOVED: "Removed";
+};
+type ReportType = typeof reportType[keyof typeof reportType];
+/**
+ * Shorthand function to return the report key.
+ */
+declare const getReportKey: (templateCode: string, typeCode: string) => string;
+//#endregion
+//#region src/lumar/graphql/server/columns.d.ts
+declare const column: {
+  readonly CUSTOM_EXTRACTION_1: "customExtraction1";
+  readonly CUSTOM_EXTRACTION_2: "customExtraction2";
+  readonly DEEP_RANK: "deepRank";
+  readonly DESCRIPTION: "description";
+  readonly DUPLICATE_PAGE: "duplicatePage";
+  readonly DUPLICATE_DESCRIPTION_FROM: "duplicateDescriptionPrimaryUrl";
+  readonly DUPLICATE_TITLE_FROM: "duplicateTitlePrimaryUrl";
+  readonly FOUND_AT_URL: "foundAtUrl";
+  readonly FOUND_IN_CRAWL: "foundInWebCrawl";
+  readonly FOUND_IN_SEARCH_CONSOLE: "foundInGoogleSearchConsole";
+  readonly FOUND_IN_SITEMAP: "foundInSitemap";
+  readonly LEVEL: "level";
+  readonly PAGE_TITLE: "pageTitle";
+  readonly PRIMARY_PAGE: "primaryPage";
+  readonly PRIMARY_URL_FROM: "primaryUrlFrom";
+  readonly PRIMARY_URL_FROM_STATUS_CODE: "primaryUrlFromStatusCode";
+  readonly REDIRECTED_TO_URL: "redirectedToUrl";
+  readonly REDIRECTED_TO_STATUS_CODE: "redirectedToStatusCode";
+  readonly REDIRECTION_CHAIN: "redirectionChain";
+  readonly SOURCE_URL: "sourceUrl";
+  readonly STATUS_CODE: "httpStatusCode";
+  readonly TARGET_STATUS_CODE: "targetStatusCode";
+  readonly URL: "url";
+  readonly URL_COUNT: "urlCount";
+  readonly URL_TO: "urlTo";
+  readonly URL_TO_STATUS_CODE: "urlToStatusCode";
+};
+type Column = typeof column[keyof typeof column];
+//#endregion
+//#region src/lumar/graphql/server/getData.d.ts
+declare const getData: (query: string, variables: object, accessToken: string) => Promise<ApiResponseClass<any, any>>;
+//#endregion
+//#region src/lumar/graphql/server/initClient.d.ts
+/**
+ * https://api-docs.lumar.io/graphql/explorer/
+ * Renew the Lumar user token.
+ */
+declare const initClient: (id: string, secret: string) => Promise<any>;
+//#endregion
+//#region src/lumar/graphql/server/reportTemplates.d.ts
+declare const reportTemplate: {
+  readonly "200_PAGES": "200_pages";
+  readonly "301_REDIRECTS": "301_redirects";
+  readonly "4XX_ERRORS": "4xx_errors";
+  readonly "5XX_ERRORS": "5xx_errors";
+  readonly ALL_PAGES: "all_pages";
+  readonly BROKEN_EXTERNAL_LINKS: "broken_links_external";
+  readonly BROKEN_INTERNAL_LINKS: "all_broken_links";
+  readonly BROKEN_SITEMAP_PAGES: "broken_sitemap_links";
+  readonly CANONICAL_CONFLICTING: "conflicting_canonical_tags";
+  readonly CANONICAL_NON_200: "canonical_to_non_200";
+  readonly CANONICAL_NON_INDEXABLE: "non_indexable_canonical_links_in";
+  readonly CANONICAL_ORPHANED: "unlinked_canonical_pages";
+  readonly CUSTOM_EXTRACTION_1: "custom_extraction_1";
+  readonly CUSTOM_EXTRACTION_2: "custom_extraction_2";
+  readonly DUPLICATE_CONTENT: "duplicate_body_content";
+  readonly DUPLICATE_DESCRIPTIONS: "pages_with_duplicate_descriptions";
+  readonly DUPLICATE_TITLES: "pages_with_duplicate_titles";
+  readonly EMPTY_PAGES: "empty_pages";
+  readonly INDEXABLE_PAGES: "indexable_pages";
+  readonly LINKED_DOMAINS: "linked_domains";
+  readonly MAX_DESCRIPTIONS: "max_description_length";
+  readonly MAX_MOBILE_DESCRIPTIONS: "max_mobile_description_length";
+  readonly MAX_TITLES: "max_title_length";
+  readonly MISSING_DESCRIPTIONS: "missing_descriptions";
+  readonly MISSING_TITLES: "missing_titles";
+  readonly NON_301_REDIRECTS: "non_301_redirects";
+  readonly NON_INDEXABLE_PAGES: "non_indexable_pages";
+  readonly NON_INDEXABLE_SITEMAP_PAGES: "sitemaps_non_indexable_links";
+  readonly ORPHANED_CANONICAL: "unlinked_canonical_pages";
+  readonly ORPHANED_ANALYTICS_PAGES: "orphaned_organic_landing_pages";
+  readonly ORPHANED_SEARCH_CONSOLE_PAGES: "orphaned_google_search_console_pages";
+  readonly ORPHANED_SITEMAP_PAGES: "orphaned_sitemaps_pages";
+  readonly PAGES_WITH_HIGH_EXTERNAL_LINKS: "max_external_links";
+  readonly PERFORMANCE_MAX_FETCH_TIME: "max_load_time";
+  readonly PERFORMANCE_POOR_CLS: "poor_cls";
+  readonly PERFORMANCE_SLOW_DCL: "slow_dcl";
+  readonly PERFORMANCE_SLOW_FCP: "slow_fcp";
+  readonly PERFORMANCE_SLOW_LCP: "slow_lcp";
+  readonly PERFORMANCE_SLOW_TTFB: "slow_server_response";
+  readonly PERFORMANCE_SLOW_TTI: "slow_tti";
+  readonly PRIMARY_PAGES: "unique_pages";
+  readonly REDIRECTS_BROKEN: "all_broken_redirects";
+  readonly REDIRECTS_CHAIN: "redirect_chains";
+  readonly REDIRECTS_LOOP: "redirection_loop";
+  readonly SCHEMA_BREADCRUMB: "pages_with_breadcrumb_schema";
+  readonly SCHEMA_EVENT: "pages_with_event_schema";
+  readonly SCHEMA_FAQ: "pages_with_faqpage_schema";
+  readonly SCHEMA_HOW_TO: "pages_with_howto_schema";
+  readonly SCHEMA_NEWS_ARTICLE: "pages_with_news_article_schema";
+  readonly SCHEMA_PRODUCT: "pages_with_product_schema";
+  readonly SCHEMA_QA: "pages_with_qapage_schema";
+  readonly SCHEMA_RECIPE: "pages_with_recipe_schema";
+  readonly SCHEMA_REVIEW: "pages_with_review_schema";
+  readonly SCHEMA_VIDEO: "pages_with_videoobject_schema";
+  readonly SHORT_DESCRIPTIONS: "short_descriptions";
+  readonly SHORT_TITLES: "short_titles";
+  readonly SITEMAP_PAGES: "all_sitemaps_links";
+  readonly SITEMAPS_NON_INDEXABLE_PAGES: "sitemaps_non_indexable_links";
+  readonly SITEMAPS_ORPHANED_PAGES: "orphaned_sitemaps_pages";
+  readonly SITEMAPS_MISSING_PAGES: "not_in_sitemaps_primary_indexable";
+  readonly THIN_PAGES: "thin_pages";
+  readonly TRUE_UNIQUE_PAGES: "true_uniques";
+  readonly UNIQUE_EXTERNAL_LINKS: "unique_external_links";
+  readonly UNIQUE_INTERNAL_LINKS: "unique_internal_links";
+  readonly XML_SITEMAPS: "xml_sitemaps";
+};
+type ReportTemplate = typeof reportTemplate[keyof typeof reportTemplate];
+//#endregion
+//#region src/lumar/graphql/server/queries/crawl.d.ts
+type Crawl = {
+  finishedAt: string;
+  id: number;
+  status: string;
+};
+//#endregion
+//#region src/lumar/graphql/server/queries/row.d.ts
+type RedirectChain = {
+  "isMetaRedirect": boolean;
+  "redirectsTo": null | string;
+  "result": string;
+  "statusCode": string;
+  "url": string;
+};
+type Row = {
+  "canonicalLinksInCount": number;
+  "canonicalUrlIsConsistent": boolean;
+  "canonicalizedPage": boolean;
+  "contentHtmlRatio": string;
+  "contentSize": number;
+  "crawlDatetime": string;
+  "css": boolean;
+  "customExtractionMatch": boolean;
+  "customExtraction1": any[];
+  "customExtraction2": any[];
+  "deeprank": number;
+  "description": string;
+  "descriptionLengthPx": number;
+  "descriptionLength": number;
+  "disallowedPage": boolean;
+  "duplicateBodyCount": number;
+  "duplicateBodyNonIndexable": boolean;
+  "duplicateBody": boolean;
+  "duplicateDescriptionCount": number;
+  "duplicateDescriptionNonIndexable": boolean;
+  "duplicateDescriptionPrimaryUrl": string;
+  "duplicateDescription": boolean;
+  "duplicatePageCount": number;
+  "duplicatePageNonIndexable": boolean;
+  "duplicatePage": boolean;
+  "duplicateTitleCount": number;
+  "duplicateTitleNonIndexable": boolean;
+  "duplicateTitlePrimaryUrl": string;
+  "duplicateTitle": boolean;
+  "encodingHeader": string;
+  "externalLinksCount": number;
+  "fetchTime": string;
+  "folderCount": number;
+  "followedExternalLinksOutCount": number;
+  "followedLinksInCount": number;
+  "foundAtUrl": string;
+  "foundInBacklinks": boolean;
+  "foundInGoogleAnalytics": boolean;
+  "foundInGoogleSearchConsole": boolean;
+  "foundInList": boolean;
+  "foundInLogSummary": boolean;
+  "foundInSitemap": boolean;
+  "foundInWebCrawl": boolean;
+  "h1Count": number;
+  "h1Length": number;
+  "headerContentType": string;
+  "headerNoarchive": boolean;
+  "headerNofollow": boolean;
+  "headerNoindex": boolean;
+  "headerNoodp": boolean;
+  "headerNosnippet": boolean;
+  "headerNoydir": boolean;
+  "hreflangLinksInCount": number;
+  "hreflangLinksOutCount": number;
+  "hreflangOnHeader": boolean;
+  "hreflangOnPage": boolean;
+  "hreflangOnSitemap": boolean;
+  "hreflangUrlCount": number;
+  "hsts": string;
+  "htmlSize": number;
+  "httpStatusCode": number;
+  "https": boolean;
+  "indexable": boolean;
+  "internalLinksCount": number;
+  "internal": boolean;
+  "isImage": boolean;
+  "isRedirectLoop": boolean;
+  "isRedirect": boolean;
+  "isSelfCanonical": boolean;
+  "js": boolean;
+  "level": number;
+  "linksInCount": number;
+  "linksOutCount": number;
+  "metaDisabledSitelinks": boolean;
+  "metaNoarchive": boolean;
+  "metaNofollow": boolean;
+  "metaNoindex": boolean;
+  "metaNoodp": boolean;
+  "metaNosnippet": boolean;
+  "metaNoydir": boolean;
+  "metaRedirect": boolean;
+  "mobileDesktopContentMismatch": boolean;
+  "mobileRelAlternateUrlIsConsistent": boolean;
+  "mobileRelAlternate": boolean;
+  "mobileRelAmphtml": boolean;
+  "newsarticleAuthorSchemaValue": string;
+  "noarchive": boolean;
+  "nofollowedPage": boolean;
+  "noindex": boolean;
+  "noodp": boolean;
+  "nosnippet": boolean;
+  "noydir": boolean;
+  "page1": boolean;
+  "pageTitle": string;
+  "pageTitleLengthPx": number;
+  "pageTitleLength": number;
+  "paginatedPage": boolean;
+  "productAvailabilitySchemaValue": string;
+  "productBrandSchemaValue": string;
+  "productSkuSchemaValue": string;
+  "primaryPage": boolean;
+  "primaryUrlFrom": string;
+  "primaryUrlFromStatusCode": string;
+  "paramCount": number;
+  "path0": string;
+  "path1": string;
+  "path2": string;
+  "path3": string;
+  "pathCount": number;
+  "performanceCls"?: number;
+  "performanceDcl"?: number;
+  "performanceFcp"?: number;
+  "performanceLcp"?: number;
+  "performanceTtfb"?: number;
+  "performanceTti"?: number;
+  "previousPath": string;
+  "previousPathDigest": string;
+  "rawHeader": {
+    [key: string]: string;
+  };
+  "redirectChain": RedirectChain[];
+  "redirectCount": number;
+  "redirectedToStatusCode": number;
+  "redirectedToUrlDigest": string;
+  "redirectedToUrl": string;
+  "redirectsInCount": number;
+  "relLinksInCount": number;
+  "relNextUrlIsConsistent": boolean;
+  "relPrevUrlIsConsistent": boolean;
+  "responsive": boolean;
+  "robotsNoindex": boolean;
+  "secureFormInputField": boolean;
+  "separateDesktop": boolean;
+  "separateMobile": boolean;
+  "sitemapsInCount": number;
+  "sourceUrl": string;
+  "urlAliasDigest": string;
+  "urlAlias": string;
+  "urlDigest": string;
+  "urlLength": number;
+  "url": string;
+  "urlCount": number;
+  "urlTo": string;
+  "urlToStatusCode": number;
+  "validTwitterCard": boolean;
+  "varyUserAgent": boolean;
+  "wordCount": number;
+};
+//#endregion
+export { Column, Crawl, Operand, ReportTemplate, ReportType, Row, column, getData, getReportKey, initClient, operand, reportTemplate, reportType };

package/dist/lumar/graphql/server/index.mjs

@@ -0,0 +1,172 @@
+import "../../../api-DGKJDAfb.mjs";
+import { post } from "../../../axios/index.mjs";
+
+//#region src/lumar/graphql/server/lumarGraphql.ts
+const operand = {
+	CONTAINS: "contains",
+	DOESNT_CONTAIN: "notContains",
+	DOESNT_MATCH_REGEX: "notMatchesRegex",
+	ENDS_WITH: "endsWith",
+	EQUALS: "eq",
+	GREATER_THAN: "gt",
+	GREATER_THAN_OR_EQUAL: "ge",
+	IS_EMPTY: "isEmpty",
+	LESS_THAN: "lt",
+	LESS_THAN_OR_EQUAL: "le",
+	MATCHES_REGEX: "matchesRegex",
+	NOT_EQUALS: "ne",
+	STARTS_WITH: "beginsWith"
+};
+const reportType = {
+	ADDED: "Added",
+	BASIC: "Basic",
+	MISSING: "Missing",
+	REMOVED: "Removed"
+};
+/**
+* Shorthand function to return the report key.
+*/
+const getReportKey = (templateCode, typeCode) => {
+	return `${templateCode}-${typeCode}`.toLowerCase();
+};
+
+//#endregion
+//#region src/lumar/graphql/server/columns.ts
+const column = {
+	CUSTOM_EXTRACTION_1: "customExtraction1",
+	CUSTOM_EXTRACTION_2: "customExtraction2",
+	DEEP_RANK: "deepRank",
+	DESCRIPTION: "description",
+	DUPLICATE_PAGE: "duplicatePage",
+	DUPLICATE_DESCRIPTION_FROM: "duplicateDescriptionPrimaryUrl",
+	DUPLICATE_TITLE_FROM: "duplicateTitlePrimaryUrl",
+	FOUND_AT_URL: "foundAtUrl",
+	FOUND_IN_CRAWL: "foundInWebCrawl",
+	FOUND_IN_SEARCH_CONSOLE: "foundInGoogleSearchConsole",
+	FOUND_IN_SITEMAP: "foundInSitemap",
+	LEVEL: "level",
+	PAGE_TITLE: "pageTitle",
+	PRIMARY_PAGE: "primaryPage",
+	PRIMARY_URL_FROM: "primaryUrlFrom",
+	PRIMARY_URL_FROM_STATUS_CODE: "primaryUrlFromStatusCode",
+	REDIRECTED_TO_URL: "redirectedToUrl",
+	REDIRECTED_TO_STATUS_CODE: "redirectedToStatusCode",
+	REDIRECTION_CHAIN: "redirectionChain",
+	SOURCE_URL: "sourceUrl",
+	STATUS_CODE: "httpStatusCode",
+	TARGET_STATUS_CODE: "targetStatusCode",
+	URL: "url",
+	URL_COUNT: "urlCount",
+	URL_TO: "urlTo",
+	URL_TO_STATUS_CODE: "urlToStatusCode"
+};
+
+//#endregion
+//#region src/lumar/graphql/server/getData.ts
+const getData = async (query, variables, accessToken) => {
+	let queryClean = query.trim();
+	queryClean = queryClean.replace(/\n/g, " ");
+	queryClean = queryClean.replace(/\t/g, " ");
+	queryClean = queryClean.replace(/  /g, " ");
+	return await post("https://api.lumar.io/graphql", {
+		query: queryClean,
+		variables
+	}, { headers: { "x-auth-token": accessToken } });
+};
+
+//#endregion
+//#region src/lumar/graphql/server/initClient.ts
+const lumarGraphQls = /* @__PURE__ */ new Map();
+/**
+* https://api-docs.lumar.io/graphql/explorer/
+* Renew the Lumar user token.
+*/
+const initClient = async (id, secret) => {
+	if (lumarGraphQls.has(id)) return lumarGraphQls.get(id);
+	const token = (await post(`https://api.lumar.io/graphql`, {
+		query: "mutation LoginWithUserKey($secret: String!, $userKeyId: ObjectID!) {  createSessionUsingUserKey(input: {userKeyId: $userKeyId, secret: $secret}) {    token  }}",
+		variables: {
+			userKeyId: id,
+			secret
+		}
+	})).getBodyDefaultTo([
+		"data",
+		"createSessionUsingUserKey",
+		"token"
+	], null);
+	lumarGraphQls.set(id, token);
+	return token;
+};
+
+//#endregion
+//#region src/lumar/graphql/server/reportTemplates.ts
+const reportTemplate = {
+	"200_PAGES": "200_pages",
+	"301_REDIRECTS": "301_redirects",
+	"4XX_ERRORS": "4xx_errors",
+	"5XX_ERRORS": "5xx_errors",
+	ALL_PAGES: "all_pages",
+	BROKEN_EXTERNAL_LINKS: "broken_links_external",
+	BROKEN_INTERNAL_LINKS: "all_broken_links",
+	BROKEN_SITEMAP_PAGES: "broken_sitemap_links",
+	CANONICAL_CONFLICTING: "conflicting_canonical_tags",
+	CANONICAL_NON_200: "canonical_to_non_200",
+	CANONICAL_NON_INDEXABLE: "non_indexable_canonical_links_in",
+	CANONICAL_ORPHANED: "unlinked_canonical_pages",
+	CUSTOM_EXTRACTION_1: "custom_extraction_1",
+	CUSTOM_EXTRACTION_2: "custom_extraction_2",
+	DUPLICATE_CONTENT: "duplicate_body_content",
+	DUPLICATE_DESCRIPTIONS: "pages_with_duplicate_descriptions",
+	DUPLICATE_TITLES: "pages_with_duplicate_titles",
+	EMPTY_PAGES: "empty_pages",
+	INDEXABLE_PAGES: "indexable_pages",
+	LINKED_DOMAINS: "linked_domains",
+	MAX_DESCRIPTIONS: "max_description_length",
+	MAX_MOBILE_DESCRIPTIONS: "max_mobile_description_length",
+	MAX_TITLES: "max_title_length",
+	MISSING_DESCRIPTIONS: "missing_descriptions",
+	MISSING_TITLES: "missing_titles",
+	NON_301_REDIRECTS: "non_301_redirects",
+	NON_INDEXABLE_PAGES: "non_indexable_pages",
+	NON_INDEXABLE_SITEMAP_PAGES: "sitemaps_non_indexable_links",
+	ORPHANED_CANONICAL: "unlinked_canonical_pages",
+	ORPHANED_ANALYTICS_PAGES: "orphaned_organic_landing_pages",
+	ORPHANED_SEARCH_CONSOLE_PAGES: "orphaned_google_search_console_pages",
+	ORPHANED_SITEMAP_PAGES: "orphaned_sitemaps_pages",
+	PAGES_WITH_HIGH_EXTERNAL_LINKS: "max_external_links",
+	PERFORMANCE_MAX_FETCH_TIME: "max_load_time",
+	PERFORMANCE_POOR_CLS: "poor_cls",
+	PERFORMANCE_SLOW_DCL: "slow_dcl",
+	PERFORMANCE_SLOW_FCP: "slow_fcp",
+	PERFORMANCE_SLOW_LCP: "slow_lcp",
+	PERFORMANCE_SLOW_TTFB: "slow_server_response",
+	PERFORMANCE_SLOW_TTI: "slow_tti",
+	PRIMARY_PAGES: "unique_pages",
+	REDIRECTS_BROKEN: "all_broken_redirects",
+	REDIRECTS_CHAIN: "redirect_chains",
+	REDIRECTS_LOOP: "redirection_loop",
+	SCHEMA_BREADCRUMB: "pages_with_breadcrumb_schema",
+	SCHEMA_EVENT: "pages_with_event_schema",
+	SCHEMA_FAQ: "pages_with_faqpage_schema",
+	SCHEMA_HOW_TO: "pages_with_howto_schema",
+	SCHEMA_NEWS_ARTICLE: "pages_with_news_article_schema",
+	SCHEMA_PRODUCT: "pages_with_product_schema",
+	SCHEMA_QA: "pages_with_qapage_schema",
+	SCHEMA_RECIPE: "pages_with_recipe_schema",
+	SCHEMA_REVIEW: "pages_with_review_schema",
+	SCHEMA_VIDEO: "pages_with_videoobject_schema",
+	SHORT_DESCRIPTIONS: "short_descriptions",
+	SHORT_TITLES: "short_titles",
+	SITEMAP_PAGES: "all_sitemaps_links",
+	SITEMAPS_NON_INDEXABLE_PAGES: "sitemaps_non_indexable_links",
+	SITEMAPS_ORPHANED_PAGES: "orphaned_sitemaps_pages",
+	SITEMAPS_MISSING_PAGES: "not_in_sitemaps_primary_indexable",
+	THIN_PAGES: "thin_pages",
+	TRUE_UNIQUE_PAGES: "true_uniques",
+	UNIQUE_EXTERNAL_LINKS: "unique_external_links",
+	UNIQUE_INTERNAL_LINKS: "unique_internal_links",
+	XML_SITEMAPS: "xml_sitemaps"
+};
+
+//#endregion
+export { column, getData, getReportKey, initClient, operand, reportTemplate, reportType };