@tmdb-graphql-api/rest-client 0.0.6

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@tmdb-graphql-api/rest-client",
+  "description": "The TMDB GraphQL rest client module.",
+  "version": "0.0.6",
+  "author": "Dylan Aubrey",
+  "license": "MIT",
+  "homepage": "https://github.com/badbatch/themoviedb-graphql-api",
+  "repository": {
+    "directory": "packages/rest-client",
+    "type": "git",
+    "url": "https://github.com/badbatch/themoviedb-graphql-api/packages/rest-client"
+  },
+  "bugs": "https://github.com/badbatch/themoviedb-graphql-api/issues",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/types/cjs/index.d.cts",
+  "exports": {
+    "types": {
+      "import": "./dist/types/esm/index.d.ts",
+      "require": "./dist/types/cjs/index.d.cts"
+    },
+    "import": "./dist/esm/index.mjs",
+    "require": "./dist/cjs/index.cjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cachemap/core": "^5.0.7",
+    "@graphql-box/core": "^5.0.0",
+    "getta": "^1.0.4",
+    "type-fest": "^4.5.0"
+  },
+  "peerDependencies": {
+    "@babel/runtime": "<8",
+    "core-js": "<4",
+    "lodash-es": "<5"
+  },
+  "devDependencies": {
+    "@babel/runtime": "^7.23.2",
+    "@jest/globals": "^29.7.0",
+    "@types/lodash-es": "^4.14.191",
+    "core-js": "^3.33.1",
+    "cts-types": "^0.0.4",
+    "del-cli": "^5.1.0",
+    "lodash-es": "^4.17.21"
+  },
+  "scripts": {
+    "build": "pnpm run clean:dist && pnpm run compile",
+    "clean:deps": "del-cli ./node_modules",
+    "clean:dist": "del-cli ./dist",
+    "compile": "pnpm run /^compile:.*/",
+    "compile:cjs": "MODULE_SYSTEM=cjs rollup -c ../../rollup.config.cjs",
+    "compile:esm": "rollup -c ../../rollup.config.cjs",
+    "compile:types": "tsc --project ./tsconfig.build.json && cts-types build dist/types/esm dist/types/cjs"
+  }
+}

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

@@ -0,0 +1,57 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createRestClient > WHEN the dollygrip rest client is created > THEN it should have the correct properties and methods 1`] = `
+Getta {
+  "_basePath": "https://api.themoviedb.org/3/",
+  "_bodyParser": [Function],
+  "_cache": "mock-cache",
+  "_conditionalRequestsEnabled": true,
+  "_fetchTimeout": 5000,
+  "_headers": {
+    "content-type": "application/json",
+  },
+  "_log": [Function],
+  "_maxRedirects": 5,
+  "_maxRetries": 3,
+  "_optionalPathTemplateRegExp": /\\(\\{\\\\w\\+\\\\\\?\\}\\)/g,
+  "_pathTemplateCallback": [Function],
+  "_pathTemplateRegExp": /\\(\\{type\\}\\)\\|\\(\\{subType\\}\\)\\|\\(\\{number\\}\\)\\|\\(\\{seasonNumber\\}\\)\\|\\(\\{episodeNumber\\}\\)\\|\\(\\{id\\}\\)/g,
+  "_performance": "mock-performance",
+  "_queryParams": {
+    "api_key": "12345",
+  },
+  "_rateLimit": false,
+  "_rateLimitCount": 0,
+  "_rateLimitPerSecond": 30,
+  "_rateLimitTimer": undefined,
+  "_rateLimitedRequestQueue": [],
+  "_requestRetryWait": 100,
+  "_requestTracker": {
+    "active": [],
+    "pending": Map {},
+  },
+  "_streamReader": "json",
+  "authenticate": [Function],
+  "certifications": [Function],
+  "collection": [Function],
+  "company": [Function],
+  "configuration": [Function],
+  "credit": [Function],
+  "discover": [Function],
+  "episode": [Function],
+  "find": [Function],
+  "genres": [Function],
+  "keyword": [Function],
+  "movie": [Function],
+  "network": [Function],
+  "person": [Function],
+  "popular": [Function],
+  "rated": [Function],
+  "review": [Function],
+  "search": [Function],
+  "season": [Function],
+  "trending": [Function],
+  "tv": [Function],
+  "watchProviders": [Function],
+}
+`;

package/src/constants.ts

@@ -0,0 +1,31 @@
+export const BASE_PATH = 'https://api.themoviedb.org/3/';
+
+export const GET_METHOD = 'get' as const;
+export const POST_METHOD = 'post' as const;
+export const PUT_METHOD = 'put' as const;
+export const DELETE_METHOD = 'delete' as const;
+
+export const OPTIONAL_TYPE_PATH_TEMPLATE_REGEX = /({type\?})/g;
+
+export const AUTHENTICATE_PATH = 'authentication/{type}/new';
+export const CERTIFICATIONS_PATH = 'certification/{type}/list';
+export const COLLECTION_PATH = 'collection/{id}/{type?}';
+export const COMPANY_PATH = 'company/{id}/{type?}';
+export const CONFIGURATION_PATH = 'configuration/{type?}';
+export const CREDIT_PATH = 'credit/{id}';
+export const DISCOVER_PATH = 'discover/{type}';
+export const EPISODE_PATH = 'tv/{id}/season/{seasonNumber}/episode/{episodeNumber}/{type?}';
+export const FIND_PATH = 'find/{id}';
+export const GENRE_PATH = 'genre/{type}/list';
+export const KEYWORD_PATH = 'keyword/{id}';
+export const MOVIE_PATH = 'movie/{id}/{type?}';
+export const NETWORK_PATH = 'network/{id}/{type?}';
+export const PERSON_PATH = 'person/{id}/{type?}';
+export const POPULAR_PATH = '{type}/popular';
+export const RATED_PATH = 'guest_session/{id}/rated/{type}';
+export const REVIEW_PATH = 'review/{id}';
+export const SEARCH_PATH = 'search/{type}';
+export const SEASON_PATH = 'tv/{id}/season/{number}/{type?}';
+export const TRENDING_PATH = 'trending/{type}/{subType}';
+export const TV_PATH = 'tv/{id}/{type?}';
+export const WATCH_PROVIDER_PATH = '{type}/{id}/watch/providers';

package/src/helpers/pathTemplateCallback.ts

@@ -0,0 +1,11 @@
+import { defaultPathTemplateCallback } from 'getta';
+import { OPTIONAL_TYPE_PATH_TEMPLATE_REGEX } from '../constants.ts';
+
+export const pathTemplateCallback = (
+  pathTemplate: string,
+  data: Record<string, string>,
+  pathTemplateRegExp: RegExp
+) => {
+  const populatedPath = defaultPathTemplateCallback(pathTemplate, data, pathTemplateRegExp);
+  return populatedPath.replace(OPTIONAL_TYPE_PATH_TEMPLATE_REGEX, data.type ?? '');
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './constants.ts';
+export { createRestClient } from './main.ts';
+export * from './types.ts';

package/src/main.test.ts

@@ -0,0 +1,21 @@
+import type { Core } from '@cachemap/core';
+import { jest } from '@jest/globals';
+
+jest.unstable_mockModule('node:perf_hooks', () => ({
+  performance: 'mock-performance',
+}));
+
+describe('createRestClient >', () => {
+  describe('WHEN the dollygrip rest client is created >', () => {
+    it('THEN it should have the correct properties and methods', async () => {
+      const { createRestClient } = await import('./index.ts');
+
+      const restClient = createRestClient({
+        cache: 'mock-cache' as unknown as Core,
+        queryParams: { api_key: '12345' },
+      });
+
+      expect(restClient).toMatchSnapshot();
+    });
+  });
+});

package/src/main.ts

@@ -0,0 +1,78 @@
+import { RESOLVER_EXECUTED, RESOLVER_RESOLVED } from '@graphql-box/core';
+import { REQUEST_SENT, RESPONSE_RECEIVED, createRestClient as create } from 'getta';
+import { performance } from 'node:perf_hooks';
+import {
+  AUTHENTICATE_PATH,
+  BASE_PATH,
+  CERTIFICATIONS_PATH,
+  COLLECTION_PATH,
+  COMPANY_PATH,
+  CONFIGURATION_PATH,
+  CREDIT_PATH,
+  DISCOVER_PATH,
+  EPISODE_PATH,
+  FIND_PATH,
+  GENRE_PATH,
+  GET_METHOD,
+  KEYWORD_PATH,
+  MOVIE_PATH,
+  NETWORK_PATH,
+  PERSON_PATH,
+  POPULAR_PATH,
+  RATED_PATH,
+  REVIEW_PATH,
+  SEARCH_PATH,
+  SEASON_PATH,
+  TRENDING_PATH,
+  TV_PATH,
+  WATCH_PROVIDER_PATH,
+} from './constants.ts';
+import { pathTemplateCallback } from './helpers/pathTemplateCallback.ts';
+import type { CreateRestClientParams, ShortcutMethodNames } from './types.ts';
+
+const { NODE_ENV } = process.env;
+
+export const createRestClient = ({ cache, debugManager, queryParams }: CreateRestClientParams) =>
+  create<ShortcutMethodNames>(
+    {
+      basePath: BASE_PATH,
+      cache,
+      fetchTimeout: NODE_ENV === 'development' ? 999_999 : undefined,
+      log: (message, data, logLevel) => {
+        if (message === REQUEST_SENT) {
+          debugManager?.log(RESOLVER_EXECUTED, data, logLevel);
+        } else if (message === RESPONSE_RECEIVED) {
+          debugManager?.log(RESOLVER_RESOLVED, data, logLevel);
+        }
+      },
+      pathTemplateCallback,
+      pathTemplateRegExp: /({type})|({subType})|({number})|({seasonNumber})|({episodeNumber})|({id})/g,
+      performance,
+      queryParams,
+      rateLimitPerSecond: 30,
+    },
+    {
+      authenticate: [AUTHENTICATE_PATH, { method: GET_METHOD }],
+      certifications: [CERTIFICATIONS_PATH, { method: GET_METHOD }],
+      collection: [COLLECTION_PATH, { method: GET_METHOD }],
+      company: [COMPANY_PATH, { method: GET_METHOD }],
+      configuration: [CONFIGURATION_PATH, { method: GET_METHOD }],
+      credit: [CREDIT_PATH, { method: GET_METHOD }],
+      discover: [DISCOVER_PATH, { method: GET_METHOD }],
+      episode: [EPISODE_PATH, { method: GET_METHOD }],
+      find: [FIND_PATH, { method: GET_METHOD }],
+      genres: [GENRE_PATH, { method: GET_METHOD }],
+      keyword: [KEYWORD_PATH, { method: GET_METHOD }],
+      movie: [MOVIE_PATH, { method: GET_METHOD }],
+      network: [NETWORK_PATH, { method: GET_METHOD }],
+      person: [PERSON_PATH, { method: GET_METHOD }],
+      popular: [POPULAR_PATH, { method: GET_METHOD }],
+      rated: [RATED_PATH, { method: GET_METHOD }],
+      review: [REVIEW_PATH, { method: GET_METHOD }],
+      search: [SEARCH_PATH, { method: GET_METHOD }],
+      season: [SEASON_PATH, { method: GET_METHOD }],
+      trending: [TRENDING_PATH, { method: GET_METHOD }],
+      tv: [TV_PATH, { method: GET_METHOD }],
+      watchProviders: [WATCH_PROVIDER_PATH, { method: GET_METHOD }],
+    }
+  );

package/src/types.ts

@@ -0,0 +1,35 @@
+import type { Core } from '@cachemap/core';
+import type { DebugManagerDef } from '@graphql-box/core';
+import type { JsonObject } from 'type-fest';
+
+export type ShortcutMethodNames =
+  | 'authenticate'
+  | 'certifications'
+  | 'collection'
+  | 'company'
+  | 'configuration'
+  | 'credit'
+  | 'discover'
+  | 'episode'
+  | 'find'
+  | 'genres'
+  | 'keyword'
+  | 'latest'
+  | 'movie'
+  | 'network'
+  | 'person'
+  | 'popular'
+  | 'rated'
+  | 'review'
+  | 'search'
+  | 'season'
+  | 'trending'
+  | 'tv'
+  | 'watchProviders';
+
+export interface CreateRestClientParams {
+  cache?: Core;
+  debugManager?: DebugManagerDef;
+  // eslint-disable-next-line camelcase
+  queryParams: JsonObject & { api_key: string; language?: string };
+}

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist/types/esm"
+  },
+  "exclude": [
+    "**/*.test.*"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@repodog/ts-config/build.json",
+  "include": [
+    "src/**/*",
+    "src/**/*.json"
+  ],
+  "references": []
+}