@nxgt/shared-graphql 1.0.0

package/dist/utils/codegen.utils.d.ts

@@ -0,0 +1,68 @@
+export declare const SCALARS_MAPPING: {
+    ID: string;
+    DateTime: string;
+    Date: string;
+    Any: string;
+    BigInt: string;
+    EmailAddress: string;
+    GeoJSON: string;
+    HSL: string;
+    HSLA: string;
+    HexColorCode: string;
+    Hexadecimal: string;
+    IBAN: string;
+    IP: string;
+    Time: string;
+    LocalTime: string;
+    UUID: string;
+    PositiveInt: string;
+    NegativeInt: string;
+    NonPositiveInt: string;
+    NonNegativeInt: string;
+    PositiveFloat: string;
+    NegativeFloat: string;
+    NonPositiveFloat: string;
+    NonNegativeFloat: string;
+    NonEmptyString: string;
+    PostalCode: string;
+    RGB: string;
+    RGBA: string;
+    SESSN: string;
+    Timestamp: string;
+    URL: string;
+    USCurrency: string;
+    UTCOffset: string;
+    Long: string;
+    Short: string;
+    Byte: string;
+    BigDecimal: string;
+    BigInteger: string;
+    Char: string;
+    Locale: string;
+    CountryCode: string;
+    CountryName: string;
+    AccountNumber: string;
+    CurrencyCode: string;
+    Duration: string;
+    Url: string;
+    JSONObject: string;
+    JSON: string;
+    Void: string;
+    ObjectID: string;
+    Upload: string;
+    Email: string;
+    Port: string;
+    IPv4: string;
+    IPv6: string;
+    MAC: string;
+    Password: string;
+    PhoneNumber: string;
+    ZIPCode: string;
+    SSN: string;
+    GUID: string;
+    ISBN: string;
+    Latitude: string;
+    Longitude: string;
+    JWT: string;
+};
+//# sourceMappingURL=codegen.utils.d.ts.map

package/dist/utils/codegen.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegen.utils.d.ts","sourceRoot":"","sources":["../../src/utils/codegen.utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkE3B,CAAC"}

package/dist/utils/data-loader.utils.d.ts

@@ -0,0 +1,14 @@
+import { type HydratedDocument, type IConnection, type Model, type PaginationOptions, type SimplePaginationOptions } from '@nxgt/shared-mongo';
+import DataLoader from 'dataloader';
+export declare function createDataLoader<K, V>(batchLoadFn: DataLoader.BatchLoadFn<K, V>, options?: DataLoader.Options<K, V, K>): DataLoader<K, V, K>;
+export declare function createConnectionListDataLoader<K, V>(path: keyof K, model: Model<V, any, any, any, any, any, any>, options: PaginationOptions): DataLoader<K, IConnection<HydratedDocument<V>>, K>;
+export declare function createChildrenConnectionDataLoader<K, V>(path: keyof V, model: Model<V, any, any, any, any, any, any>, options: PaginationOptions): DataLoader<HydratedDocument<K>, IConnection<HydratedDocument<V>>, HydratedDocument<K>>;
+export declare function createSimpleListDataLoader<K, V>(path: keyof K, model: Model<V, any, any, any, any, any, any>, options?: SimplePaginationOptions): DataLoader<K, HydratedDocument<V>[], K>;
+export declare function createChildrenListDataLoader<K, V>(path: keyof V, model: Model<V, any, any, any, any, any, any>, options?: SimplePaginationOptions): DataLoader<HydratedDocument<K>, HydratedDocument<V>[], HydratedDocument<K>>;
+export declare function createSingleChildDataLoader<K, V extends {
+    id: string;
+}>(path: keyof K, model: Model<V, any, any, any, any, any, any>): DataLoader<K, HydratedDocument<V> | null, K>;
+export declare function createEntitiesReferenceLoader<V extends {
+    id: string;
+}>(model: Model<V, any, any, any, any, any, any>): DataLoader<string, HydratedDocument<V> | null>;
+//# sourceMappingURL=data-loader.utils.d.ts.map

package/dist/utils/data-loader.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-loader.utils.d.ts","sourceRoot":"","sources":["../../src/utils/data-loader.utils.ts"],"names":[],"mappings":"AACA,OAAO,EACN,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,KAAK,EAEV,KAAK,iBAAiB,EAGtB,KAAK,uBAAuB,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,UAAU,MAAM,YAAY,CAAC;AAGpC,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EACpC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACzC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,uBAGrC;AAED,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,CAAC,EAClD,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE,iBAAiB,sDAiC1B;AAED,wBAAgB,kCAAkC,CAAC,CAAC,EAAE,CAAC,EACtD,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE,iBAAiB,0FAoB1B;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,CAAC,EAC9C,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,CAAC,EAAE,uBAAuB,2CA+BjC;AAED,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,CAAC,EAChD,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7C,OAAO,CAAC,EAAE,uBAAuB,+EA6BjC;AAED,wBAAgB,2BAA2B,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EACtE,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,gDAmB7C;AAED,wBAAgB,6BAA6B,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EACrE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAgBvC,UAAU,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CACpD"}

package/dist/utils/errors.utils.d.ts

@@ -0,0 +1,23 @@
+import type { ApolloServerOptions } from '@apollo/server';
+import { type LocaleKey, type TranslationContext } from '@nxgt/i18n';
+import { GraphQLError, type GraphQLErrorOptions } from 'graphql';
+import type { MaskError } from 'graphql-yoga';
+import type { GraphQLBaseContext } from '../types';
+export declare function createGraphQLError(message: string, options?: GraphQLErrorOptions): GraphQLError;
+export declare function createFormatError<K extends LocaleKey, C extends GraphQLBaseContext = GraphQLBaseContext>(translate?: (message: K, context?: TranslationContext) => string, production?: boolean): ApolloServerOptions<C>['formatError'];
+/**
+ * Yoga's `maskedErrors.maskError`, taught this repo's exceptions.
+ *
+ * Yoga masks anything that is not a `GraphQLError` as "Unexpected error." —
+ * and `CustomException` extends `Error`, so out of the box a service's
+ * `notFound()` or `forbidden()` reaches the client as an opaque 500. This
+ * turns one into a `GraphQLError` with the translated message, the
+ * exception's `code` in `extensions`, and a matching HTTP status; a Mongoose
+ * error goes through `castError` first, as `createFormatError` does for
+ * Apollo. `OryUnavailable` (stx-sdk/ory) becomes a 503 `SERVICE_UNAVAILABLE`,
+ * never a denial. Everything else is masked exactly as before.
+ *
+ *     createYoga({ maskedErrors: { maskError: createMaskError(translate) } })
+ */
+export declare function createMaskError<K extends LocaleKey>(translate?: (message: K, context?: TranslationContext) => string): MaskError;
+//# sourceMappingURL=errors.utils.d.ts.map

package/dist/utils/errors.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.utils.d.ts","sourceRoot":"","sources":["../../src/utils/errors.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAK1D,OAAO,EACN,KAAK,SAAS,EACd,KAAK,kBAAkB,EAEvB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAG9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,mBAAmB,GAC3B,YAAY,CAEd;AAED,wBAAgB,iBAAiB,CAChC,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EAEjD,SAAS,GAAE,CACV,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,kBAAkB,KACxB,MAAsB,EAC3B,UAAU,CAAC,EAAE,OAAO,GAClB,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAoDvC;AAYD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,EAClD,SAAS,GAAE,CACV,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,kBAAkB,KACxB,MAAsB,GACzB,SAAS,CAkDX"}

package/dist/utils/index.d.ts

@@ -0,0 +1,10 @@
+export * from './change-resolvers.utils';
+export * from './codegen.utils';
+export * from './data-loader.utils';
+export * from './errors.utils';
+export * from './publish';
+export * from './sandbox';
+export * from './schema.utils';
+export * from './websocket';
+export * from './ws-context';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/utils/publish.d.ts

@@ -0,0 +1,8 @@
+import type { Redis } from 'ioredis';
+export declare const createYogaPubSub: ({ publishClient, subscribeClient, }: {
+    publishClient: Redis;
+    subscribeClient: Redis;
+}) => import("graphql-yoga").PubSub<{
+    [key: string]: [] | [any] | [string | number, any];
+}>;
+//# sourceMappingURL=publish.d.ts.map

package/dist/utils/publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../src/utils/publish.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,gBAAgB,GAAI,qCAG9B;IACF,aAAa,EAAE,KAAK,CAAC;IACrB,eAAe,EAAE,KAAK,CAAC;CACvB;;EAOA,CAAC"}

package/dist/utils/sandbox.d.ts

@@ -0,0 +1,9 @@
+export type RenderSandboxOptions = {
+    port?: number;
+    graphqlEndpoint?: string;
+    protocol?: string;
+    hostname?: string;
+    title?: string;
+};
+export declare const renderSandbox: ({ port, hostname, graphqlEndpoint, protocol, title, }: RenderSandboxOptions) => import("hono/utils/html").HtmlEscapedString | Promise<import("hono/utils/html").HtmlEscapedString>;
+//# sourceMappingURL=sandbox.d.ts.map

package/dist/utils/sandbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox.d.ts","sourceRoot":"","sources":["../../src/utils/sandbox.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,uDAM3B,oBAAoB,uGAuBtB,CAAC"}

package/dist/utils/schema.utils.d.ts

@@ -0,0 +1,11 @@
+import { buildSubgraphSchema as buildSubgraphSchemaBase } from '@apollo/subgraph';
+export declare const SHARED_SCHEMA_PATH: string;
+export declare function loadTypeDefs(...paths: string[]): import("graphql").DocumentNode;
+export declare function buildSubgraphSchema(modulesOrSdl: Parameters<typeof buildSubgraphSchemaBase>[0]): import("graphql").GraphQLSchema;
+/**
+ * Utility function to generate a GraphQL schema file from the provided type definitions.
+ * @param output - The path where the generated schema file should be saved.
+ * @param paths - An array of glob patterns to locate the GraphQL type definition files.
+ */
+export declare function generateSchema(output: string, ...paths: string[]): Promise<void>;
+//# sourceMappingURL=schema.utils.d.ts.map

package/dist/utils/schema.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.utils.d.ts","sourceRoot":"","sources":["../../src/utils/schema.utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAMlF,eAAO,MAAM,kBAAkB,QAAqC,CAAC;AAErE,wBAAgB,YAAY,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,kCAU9C;AAED,wBAAgB,mBAAmB,CAClC,YAAY,EAAE,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,mCAK3D;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,iBAKtE"}

package/dist/utils/websocket.d.ts

@@ -0,0 +1,11 @@
+import type { ServerOptions } from 'graphql-ws';
+import type { YogaServerInstance } from 'graphql-yoga';
+export declare function setupYogaWebSocketServer<ServerContext extends {}, UserContext extends {}>({ yoga, context, }: {
+    yoga: YogaServerInstance<ServerContext, UserContext>;
+    context?: ServerOptions['context'];
+}): {
+    yoga: YogaServerInstance<ServerContext, UserContext>;
+    httpServer: import("node:http").Server<typeof import("node:http").IncomingMessage, typeof import("node:http").ServerResponse>;
+    startServer: (port: number) => Promise<void>;
+};
+//# sourceMappingURL=websocket.d.ts.map

package/dist/utils/websocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../../src/utils/websocket.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGvD,wBAAgB,wBAAwB,CACvC,aAAa,SAAS,EAAE,EACxB,WAAW,SAAS,EAAE,EACrB,EACD,IAAI,EACJ,OAAO,GACP,EAAE;IACF,IAAI,EAAE,kBAAkB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACrD,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACnC;;;wBA0C2B,MAAM;EAGjC"}

package/dist/utils/ws-context.d.ts

@@ -0,0 +1,24 @@
+import type { Principal } from '@nxgt/shared';
+import type { Context } from 'graphql-ws';
+import type { createAuthClient } from 'stx-sdk/auth';
+type AuthClient = ReturnType<typeof createAuthClient>;
+export interface ResolvedWsUser {
+    user: Principal | undefined;
+    token: string | undefined;
+}
+/**
+ * Resolves the authenticated Principal for a `graphql-ws` connection - the
+ * WS-transport equivalent of the HTTP-path `useAuth()`/`useGenericAuth()`
+ * plugins. There is no gateway hop for WS connections, so each app performs
+ * the OAuth introspection call itself using its own `auth` client.
+ *
+ * Reads the bearer token off `connectionParams.authorization` /
+ * `connectionParams.Authorization` (both casings are used by existing
+ * clients), strips the `Bearer ` prefix, and introspects it. Returns
+ * `user: undefined` for a missing, invalid, or inactive token - callers
+ * pass `user ?? null` into their own `services()` factory, exactly as the
+ * HTTP-path plugins already do.
+ */
+export declare function resolveWsUser(connectionParams: Context['connectionParams'], authClient: AuthClient): Promise<ResolvedWsUser>;
+export {};
+//# sourceMappingURL=ws-context.d.ts.map

package/dist/utils/ws-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-context.d.ts","sourceRoot":"","sources":["../../src/utils/ws-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD,KAAK,UAAU,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtD,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,aAAa,CAClC,gBAAgB,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAC7C,UAAU,EAAE,UAAU,GACpB,OAAO,CAAC,cAAc,CAAC,CAezB"}

package/package.json

@@ -0,0 +1,85 @@
+{
+	"name": "@nxgt/shared-graphql",
+	"version": "1.0.0",
+	"license": "UNLICENSED",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"README.md",
+		"package.json"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./security": {
+			"types": "./dist/security/index.d.ts",
+			"import": "./dist/security/index.js",
+			"default": "./dist/security/index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/softistx/nxgt-core.git",
+		"directory": "packages/shared-graphql"
+	},
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org",
+		"access": "public"
+	},
+	"scripts": {
+		"build": "bun run ../../build.ts",
+		"typecheck": "tsc --noEmit"
+	},
+	"nxgt": {
+		"entrypoints": [
+			"src/index.ts",
+			"src/security/index.ts"
+		]
+	},
+	"dependencies": {
+		"@apollo/server": "^5.5.1",
+		"@apollo/subgraph": "^2.14.3",
+		"@envelop/extended-validation": "^7.1.1",
+		"@envelop/generic-auth": "^11.1.1",
+		"@graphql-hive/gateway": "^2.11.2",
+		"@graphql-tools/load-files": "^7.0.1",
+		"@graphql-tools/merge": "^9.2.3",
+		"@graphql-tools/utils": "^12.0.0",
+		"@graphql-yoga/redis-event-target": "^3.0.3",
+		"@hono/zod-validator": "^0.9.0",
+		"@nxgt/i18n": "1.0.0",
+		"@nxgt/security": "1.0.0",
+		"@nxgt/shared": "1.0.0",
+		"@nxgt/shared-exceptions": "1.0.0",
+		"@nxgt/shared-logging": "1.0.0",
+		"@nxgt/shared-mongo": "1.0.0",
+		"dataloader": "^2.2.3",
+		"graphql": "^16.4.2",
+		"graphql-scalars": "^1.26.0",
+		"graphql-subscriptions": "^3.0.0",
+		"graphql-upload": "^18.0.0",
+		"graphql-ws": "^6.2.1",
+		"graphql-yoga": "^5.21.3",
+		"hono": "^4.13.4",
+		"ioredis": "^6.0.0",
+		"lodash": "^4.18.1",
+		"ws": "^8.21.3",
+		"zod": "^4.4.3"
+	},
+	"devDependencies": {
+		"@types/bun": "^1.4.0",
+		"@types/graphql-upload": "^17.0.0",
+		"@types/lodash": "^4.17.25",
+		"@types/ws": "^8.18.1"
+	},
+	"peerDependencies": {
+		"stx-sdk": ">=1.0.0",
+		"typescript": "^6.0.3"
+	}
+}