@microsoft/rayfin-connector-fabric-graphql 1.34.0-alpha.1201

package/README.md

@@ -0,0 +1,15 @@
+# @microsoft/rayfin-connector-fabric-graphql
+
+> **Experimental** — this package is experimental and may change substantially in the near future.
+> Mount the typed connectors runtime via the experimental subpath of
+> `@microsoft/rayfin-client` rather than the stable `RayfinClient` entry.
+
+Base types for Rayfin's Category A (GraphQL-backed) connectors:
+`fabric-sql`, `fabric-warehouse`, `fabric-sqlanalytics`, and `fabric-graphql`.
+
+This package contributes nothing at runtime — it only exports the types
+needed to make
+`client.connectors.<name>.<Entity>.select([...]).where(...).execute()`
+strongly typed when `<name>` points at a GraphQL-backed connector in
+`rayfin.yml`. The runtime that backs the surface lives in
+`@microsoft/rayfin-connectors`.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export type { CrudOperation, RestrictedEntityClient, RestrictedDataApi, GraphQLBackedConnector, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -0,0 +1,59 @@
+import { METHODS_FOR_CRUD_OPERATION, type ConnectorMarker, type CrudOperation } from '@microsoft/rayfin-connectors';
+import type { EntitySchema, GraphQLEntityClient } from '@microsoft/rayfin-data';
+/**
+ * Re-exported from `@microsoft/rayfin-connectors` so the runtime
+ * allow-list (`ConnectorConfig.operations`), the CLI validators in
+ * `@microsoft/rayfin-tools-common`, and this type marker all reference
+ * the same union and cannot drift.
+ */
+export type { CrudOperation };
+/**
+ * The subset of `GraphQLEntityClient` method names associated with each
+ * CRUD operation. Derived from the shared runtime constant
+ * `METHODS_FOR_CRUD_OPERATION` in `@microsoft/rayfin-connectors`, so the
+ * compile-time gate and runtime gate use the exact same mapping.
+ */
+type MethodsFor<TOp extends CrudOperation> = (typeof METHODS_FOR_CRUD_OPERATION)[TOp][number];
+/**
+ * Narrows `GraphQLEntityClient<TSchema, TEntity>` to only the methods
+ * permitted by `TOps`. Disallowed methods become inaccessible at
+ * compile time — calling `connector.Entity.update(...)` on a `'read'`
+ * connector is a `Property 'update' does not exist` error.
+ */
+export type RestrictedEntityClient<TSchema extends EntitySchema, TEntity extends keyof TSchema & string, TOps extends CrudOperation> = Pick<GraphQLEntityClient<TSchema, TEntity>, MethodsFor<TOps> & keyof GraphQLEntityClient<TSchema, TEntity>>;
+/**
+ * Type-level entity API for a Category A connector: one
+ * `RestrictedEntityClient` per entity in the connector's schema, gated
+ * by `TOps`. Mirrors the shape of `TypedDataClients<TSchema>` from
+ * `@microsoft/rayfin-data` but with CRUD gating layered on.
+ */
+export type RestrictedDataApi<TSchema extends EntitySchema, TOps extends CrudOperation = CrudOperation> = {
+    [K in keyof TSchema & string]: RestrictedEntityClient<TSchema, K, TOps>;
+};
+/**
+ * Phantom marker for a Category A (GraphQL-backed) connector instance.
+ *
+ * Builders never construct this directly. The CLI generates a
+ * `schema.ts` per connector that declares e.g.
+ * `type SalesDbSchema = GraphQLBackedConnector<{ Product: typeof Product }, 'read'>;`
+ * and the typed `client.connectors.salesDb` proxy resolves to a
+ * `RestrictedDataApi<...>` whose entity clients only expose the
+ * permitted CRUD methods.
+ *
+ * Both type parameters are phantom — the fields exist only at the
+ * type level so the mapped type in `@microsoft/rayfin-connectors`
+ * can infer them via `infer S`, `infer O`.
+ *
+ * @example
+ * ```ts
+ * type LakehouseSchema = GraphQLBackedConnector<{ Product: typeof Product }, 'read'>;
+ * type SalesDbSchema = GraphQLBackedConnector<
+ *   { Product: typeof Product; Customer: typeof Customer }
+ * >;
+ * ```
+ */
+export interface GraphQLBackedConnector<TSchema extends EntitySchema = EntitySchema, TOps extends CrudOperation = CrudOperation> extends ConnectorMarker<RestrictedDataApi<TSchema, TOps>> {
+    readonly __schema?: TSchema;
+    readonly __ops?: TOps;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@microsoft/rayfin-connector-fabric-graphql",
+  "version": "1.34.0-alpha.1201",
+  "description": "Experimental Cat A GraphQL-backed connector types for the Rayfin SDK. Provides the entity-oriented marker (GraphQLBackedConnector) and CRUD operation gating used by the typed client.connectors.<name>.<Entity>.select(...).execute() surface.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "!dist/**/__tests__/**",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "eslint": "^9.28.0",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3",
+    "@vitest/coverage-v8": "~3.2.4",
+    "rimraf": "~6.0.1"
+  },
+  "dependencies": {
+    "@microsoft/rayfin-connectors": "1.34.0-alpha.1201",
+    "@microsoft/rayfin-data": "1.34.0-alpha.1201"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com",
+    "access": "restricted"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/project-rayfin.git",
+    "directory": "packages/typescript-sdk/connector-fabric-graphql"
+  },
+  "keywords": [
+    "rayfin",
+    "connector",
+    "graphql",
+    "sql"
+  ],
+  "author": "",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && node ../scripts/fix-esm-extensions.mjs ./dist",
+    "build:watch": "tsc --watch",
+    "clean": "rimraf dist && rimraf .tsbuildinfo",
+    "test": "vitest run --passWithNoTests"
+  }
+}