@luvio/compiler 0.142.3 → 0.143.0

package/README.md

@@ -0,0 +1,11 @@
+# @luvio/compiler
+
+## Purpose
+
+The Luvio Compiler package is the main code generator for API clients. It uses a two-phased approach to code generation.
+
+1. Parsing
+   - We take a RAML file and [parse it](./src/parser/main.ts) using [AMF](https://a.ml/docs/amf/using-amf/amf_parsing/) and our own custom annotations into an intermediate representation called [ModelInfo](./src/intermediate/model-info.ts);
+2. Code Generation
+   - We take the `ModelInfo` and we use it to inform generation of Typescript Api Clients. The code generator is designed to be somewhat composable, so the caller can decide which pieces of the `ModelInfo` they'd like to have generated by providing different "Source Writers" to the compiler. This is all coordinated by the [LuvioRamlCompiler](./src/compiler/raml-compiler.ts).
+   - The main transformation from pieces of `ModelInfo` to the actual Typescript code happens in [codegen](./src/codegen/).

package/dist/codegen/graphql/constants.d.ts

@@ -5,3 +5,4 @@ export declare const CREATE_FRAGMENT_MAP_IMPORT: string;
 export declare const BUILD_QUERY_TYPE_STRING_KEY_IMPORT: string;
 export declare const BUILD_QUERY_TYPE_STRUCTURED_KEY_IMPORT: string;
 export declare const GET_OPERATION_FROM_DOCUMENT_IMPORT: string;
+export declare const INVALID_OPERATION_CONFIGURATION = "InvalidOperation";

package/dist/codegen/graphql/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GET_OPERATION_FROM_DOCUMENT_IMPORT = exports.BUILD_QUERY_TYPE_STRUCTURED_KEY_IMPORT = exports.BUILD_QUERY_TYPE_STRING_KEY_IMPORT = exports.CREATE_FRAGMENT_MAP_IMPORT = exports.GRAPHQL_FRAGMENT_MAP_IMPORT = exports.SERIALIZE_FIELD_ARGUMENTS_IMPORT = exports.GRAPHQL_VARIABLES_TYPE_IMPORT = void 0;
+exports.INVALID_OPERATION_CONFIGURATION = exports.GET_OPERATION_FROM_DOCUMENT_IMPORT = exports.BUILD_QUERY_TYPE_STRUCTURED_KEY_IMPORT = exports.BUILD_QUERY_TYPE_STRING_KEY_IMPORT = exports.CREATE_FRAGMENT_MAP_IMPORT = exports.GRAPHQL_FRAGMENT_MAP_IMPORT = exports.SERIALIZE_FIELD_ARGUMENTS_IMPORT = exports.GRAPHQL_VARIABLES_TYPE_IMPORT = void 0;
 // Shared constants from the @luvio/graphql package
 const imports_1 = require("../../utils/imports");
 exports.GRAPHQL_VARIABLES_TYPE_IMPORT = (0, imports_1.namedImport)('@luvio/graphql', 'GraphQLVariables');
@@ -10,4 +10,5 @@ exports.CREATE_FRAGMENT_MAP_IMPORT = (0, imports_1.namedImport)('@luvio/graphql'
 exports.BUILD_QUERY_TYPE_STRING_KEY_IMPORT = (0, imports_1.namedImport)('@luvio/graphql', 'buildQueryTypeStringKey');
 exports.BUILD_QUERY_TYPE_STRUCTURED_KEY_IMPORT = (0, imports_1.namedImport)('@luvio/graphql', 'buildQueryTypeStructuredKey');
 exports.GET_OPERATION_FROM_DOCUMENT_IMPORT = (0, imports_1.namedImport)('@luvio/graphql', 'getOperationFromDocument');
+exports.INVALID_OPERATION_CONFIGURATION = 'InvalidOperation';
 //# sourceMappingURL=constants.js.map

package/dist/codegen/graphql/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/codegen/graphql/constants.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AACnD,iDAAkD;AAErC,QAAA,6BAA6B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;AAClF,QAAA,gCAAgC,GAAG,IAAA,qBAAW,EACvD,gBAAgB,EAChB,yBAAyB,CAC5B,CAAC;AACW,QAAA,2BAA2B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC;AAClF,QAAA,0BAA0B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;AAChF,QAAA,kCAAkC,GAAG,IAAA,qBAAW,EACzD,gBAAgB,EAChB,yBAAyB,CAC5B,CAAC;AACW,QAAA,sCAAsC,GAAG,IAAA,qBAAW,EAC7D,gBAAgB,EAChB,6BAA6B,CAChC,CAAC;AAEW,QAAA,kCAAkC,GAAG,IAAA,qBAAW,EACzD,gBAAgB,EAChB,0BAA0B,CAC7B,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/codegen/graphql/constants.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AACnD,iDAAkD;AAErC,QAAA,6BAA6B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;AAClF,QAAA,gCAAgC,GAAG,IAAA,qBAAW,EACvD,gBAAgB,EAChB,yBAAyB,CAC5B,CAAC;AACW,QAAA,2BAA2B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC;AAClF,QAAA,0BAA0B,GAAG,IAAA,qBAAW,EAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;AAChF,QAAA,kCAAkC,GAAG,IAAA,qBAAW,EACzD,gBAAgB,EAChB,yBAAyB,CAC5B,CAAC;AACW,QAAA,sCAAsC,GAAG,IAAA,qBAAW,EAC7D,gBAAgB,EAChB,6BAA6B,CAChC,CAAC;AAEW,QAAA,kCAAkC,GAAG,IAAA,qBAAW,EACzD,gBAAgB,EAChB,0BAA0B,CAC7B,CAAC;AAEW,QAAA,+BAA+B,GAAG,kBAAkB,CAAC"}

package/dist/codegen/resource/graphql/key-builder.d.ts

@@ -1,5 +1,3 @@
 import type { ImportContext } from '../../../utils/imports';
 import type { GraphQLResource } from '../../../intermediate/resource';
 export declare function generateGraphQLKeyBuilder(importContext: ImportContext, resource: GraphQLResource): string;
-export declare function generateGraphQLKey(importContext: ImportContext, returnShapeName: string): string;
-export declare function generateGraphQLStructuredKey(importContext: ImportContext, returnShapeName: string): string;

package/dist/codegen/resource/graphql/key-builder.js

@@ -3,54 +3,50 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateGraphQLStructuredKey = exports.generateGraphQLKey = exports.generateGraphQLKeyBuilder = void 0;
+exports.generateGraphQLKeyBuilder = void 0;
 const deindent_1 = __importDefault(require("../../../utils/deindent"));
 const resource_params_1 = require("./resource-params");
 const key_builder_1 = require("../key-builder");
 const constants_1 = require("../../shared/constants");
+const constants_2 = require("../../graphql/constants");
+const constants_3 = require("../../graphql/type/constants");
 function generateGraphQLKeyBuilder(importContext, resource) {
-    let code;
-    let structuredKeyCode;
-    const { id: resourceId, returnShape } = resource;
+    const { id: resourceId, graphqlDSL, returnShape } = resource;
+    const namespaceImport = importContext.importAdapterUtil('keyPrefix');
     const resourceRequestConfig = importContext.importRamlArtifact(resourceId, resource_params_1.RESOURCE_PARAMS_INTERFACE);
-    code =
-        returnShape !== undefined //TODO: cleanup in W-11069204
-            ? generateGraphQLKey(importContext, returnShape === null || returnShape === void 0 ? void 0 : returnShape.name)
-            : '';
-    structuredKeyCode =
-        returnShape !== undefined //TODO: cleanup in W-11069204
-            ? generateGraphQLStructuredKey(importContext, returnShape === null || returnShape === void 0 ? void 0 : returnShape.name)
-            : '';
+    const queryType = graphqlDSL.schema.getQueryType();
+    const GRAPHQL_QUERY_TYPE_KEYBUILDER_IMPORT = importContext.importGraphQLArtifact('types', queryType.name, constants_3.KEY_BUILDER_IDENTIFIER);
+    const GRAPHQL_QUERY_TYPE_STRUCTURED_KEYBUILDER_IMPORT = importContext.importGraphQLArtifact('types', queryType.name, constants_3.STRUCTURED_KEY_BUILDER_IDENTIFIER);
     return (0, deindent_1.default) `
             export function ${key_builder_1.RESOURCE_KEY_BUILDER_IDENTIFIER}(${constants_1.LUVIO_IDENTIFIER}: ${constants_1.LUVIO_IMPORT}, params: ${resourceRequestConfig}): string {
-                return ${code}
+                const { query, operationName, variables } = params.body;
+                const operationToExecute = ${constants_2.GET_OPERATION_FROM_DOCUMENT_IMPORT}(query, operationName);
+                if(operationToExecute !== undefined) {
+                    const fragments: ${constants_2.GRAPHQL_FRAGMENT_MAP_IMPORT} = ${constants_2.CREATE_FRAGMENT_MAP_IMPORT}(query);
+                    return ${GRAPHQL_QUERY_TYPE_KEYBUILDER_IMPORT}(${constants_1.LUVIO_IDENTIFIER}, operationToExecute, variables || {}, fragments)
+                }
+
+                return \`${namespaceImport}${constants_1.CACHE_KEY_NAMESPACE_DELIMITER}${returnShape.name}${constants_1.CACHE_KEY_NAMESPACE_DELIMITER}${constants_2.INVALID_OPERATION_CONFIGURATION}\`;
+                
             }
 
             export function ${key_builder_1.RESOURCE_STRUCTURED_KEY_BUILDER_IDENTIFIER}(${constants_1.LUVIO_IDENTIFIER}: ${constants_1.LUVIO_IMPORT}, params: ${resourceRequestConfig}): ${constants_1.LUVIO_NORMALIZED_KEY_METADATA_IMPORT} {
-                return ${structuredKeyCode}
+                const { query, operationName, variables } = params.body;
+                const operationToExecute = ${constants_2.GET_OPERATION_FROM_DOCUMENT_IMPORT}(query, operationName);
+                if(operationToExecute !== undefined) {
+                    const fragments: ${constants_2.GRAPHQL_FRAGMENT_MAP_IMPORT} = ${constants_2.CREATE_FRAGMENT_MAP_IMPORT}(query);
+                    return ${GRAPHQL_QUERY_TYPE_STRUCTURED_KEYBUILDER_IMPORT}(${constants_1.LUVIO_IDENTIFIER}, operationToExecute, variables || {}, fragments)
+                }
+
+                return ${constants_1.LUVIO_IDENTIFIER}.${constants_1.LUVIO_BUILD_STRUCTURED_KEY_METHOD_IDENTIFIER}(
+                    ${namespaceImport},
+                    '${returnShape.name}',
+                    {
+                        operation: '${constants_2.INVALID_OPERATION_CONFIGURATION}'
+                    }
+                );
             }
         `;
 }
 exports.generateGraphQLKeyBuilder = generateGraphQLKeyBuilder;
-// TODO: what is the proper shape and resource key for gql queries?
-function generateGraphQLKey(importContext, returnShapeName) {
-    const { importAdapterUtil } = importContext;
-    const KEY_PREFIX = importAdapterUtil('keyPrefix');
-    return (0, deindent_1.default) `
-            ${KEY_PREFIX} + '${constants_1.CACHE_KEY_NAMESPACE_DELIMITER}' + '${returnShapeName}';
-    `;
-}
-exports.generateGraphQLKey = generateGraphQLKey;
-function generateGraphQLStructuredKey(importContext, returnShapeName) {
-    const { importAdapterUtil } = importContext;
-    const KEY_PREFIX = importAdapterUtil('keyPrefix');
-    return (0, deindent_1.default) `
-        ${constants_1.LUVIO_IDENTIFIER}.${constants_1.LUVIO_BUILD_STRUCTURED_KEY_METHOD_IDENTIFIER}(
-            ${KEY_PREFIX},
-            '${returnShapeName}',
-            {}
-        )
-    `;
-}
-exports.generateGraphQLStructuredKey = generateGraphQLStructuredKey;
 //# sourceMappingURL=key-builder.js.map

package/dist/codegen/resource/graphql/key-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"key-builder.js","sourceRoot":"","sources":["../../../../src/codegen/resource/graphql/key-builder.ts"],"names":[],"mappings":";;;;;;AAAA,uEAA+C;AAE/C,uDAA8D;AAC9D,gDAGwB;AAGxB,sDAMgC;AAEhC,SAAgB,yBAAyB,CACrC,aAA4B,EAC5B,QAAyB;IAEzB,IAAI,IAAI,CAAC;IACT,IAAI,iBAAiB,CAAC;IACtB,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC;IAEjD,MAAM,qBAAqB,GAAG,aAAa,CAAC,kBAAkB,CAC1D,UAAU,EACV,2CAAyB,CAC5B,CAAC;IAEF,IAAI;QACA,WAAW,KAAK,SAAS,CAAC,6BAA6B;YACnD,CAAC,CAAC,kBAAkB,CAAC,aAAa,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,CAAC;YACtD,CAAC,CAAC,EAAE,CAAC;IACb,iBAAiB;QACb,WAAW,KAAK,SAAS,CAAC,6BAA6B;YACnD,CAAC,CAAC,4BAA4B,CAAC,aAAa,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,CAAC;YAChE,CAAC,CAAC,EAAE,CAAC;IAEb,OAAO,IAAA,kBAAQ,EAAA;8BACW,6CAA+B,IAAI,4BAAgB,KAAK,wBAAY,aAAa,qBAAqB;yBAC3G,IAAI;;;8BAGC,wDAA0C,IAAI,4BAAgB,KAAK,wBAAY,aAAa,qBAAqB,MAAM,gDAAoC;yBAChK,iBAAiB;;SAEjC,CAAC;AACV,CAAC;AA/BD,8DA+BC;AAED,mEAAmE;AACnE,SAAgB,kBAAkB,CAAC,aAA4B,EAAE,eAAuB;IACpF,MAAM,EAAE,iBAAiB,EAAE,GAAG,aAAa,CAAC;IAC5C,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAClD,OAAO,IAAA,kBAAQ,EAAA;cACL,UAAU,OAAO,yCAA6B,QAAQ,eAAe;KAC9E,CAAC;AACN,CAAC;AAND,gDAMC;AAED,SAAgB,4BAA4B,CACxC,aAA4B,EAC5B,eAAuB;IAEvB,MAAM,EAAE,iBAAiB,EAAE,GAAG,aAAa,CAAC;IAC5C,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAClD,OAAO,IAAA,kBAAQ,EAAA;UACT,4BAAgB,IAAI,wDAA4C;cAC5D,UAAU;eACT,eAAe;;;KAGzB,CAAC;AACN,CAAC;AAbD,oEAaC"}
+{"version":3,"file":"key-builder.js","sourceRoot":"","sources":["../../../../src/codegen/resource/graphql/key-builder.ts"],"names":[],"mappings":";;;;;;AAAA,uEAA+C;AAE/C,uDAA8D;AAC9D,gDAGwB;AAGxB,sDAMgC;AAChC,uDAKiC;AACjC,4DAGsC;AAEtC,SAAgB,yBAAyB,CACrC,aAA4B,EAC5B,QAAyB;IAEzB,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC;IAE7D,MAAM,eAAe,GAAG,aAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACrE,MAAM,qBAAqB,GAAG,aAAa,CAAC,kBAAkB,CAC1D,UAAU,EACV,2CAAyB,CAC5B,CAAC;IACF,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,EAAG,CAAC;IACpD,MAAM,oCAAoC,GAAG,aAAa,CAAC,qBAAqB,CAC5E,OAAO,EACP,SAAS,CAAC,IAAI,EACd,kCAAsB,CACzB,CAAC;IACF,MAAM,+CAA+C,GAAG,aAAa,CAAC,qBAAqB,CACvF,OAAO,EACP,SAAS,CAAC,IAAI,EACd,6CAAiC,CACpC,CAAC;IAEF,OAAO,IAAA,kBAAQ,EAAA;8BACW,6CAA+B,IAAI,4BAAgB,KAAK,wBAAY,aAAa,qBAAqB;;6CAEvF,8CAAkC;;uCAExC,uCAA2B,MAAM,sCAA0B;6BACrE,oCAAoC,IAAI,4BAAgB;;;2BAG1D,eAAe,GAAG,yCAA6B,GAClE,WAAY,CAAC,IACjB,GAAG,yCAA6B,GAAG,2CAA+B;;;;8BAIxC,wDAA0C,IAAI,4BAAgB,KAAK,wBAAY,aAAa,qBAAqB,MAAM,gDAAoC;;6CAE5I,8CAAkC;;uCAExC,uCAA2B,MAAM,sCAA0B;6BACrE,+CAA+C,IAAI,4BAAgB;;;yBAGvE,4BAAgB,IAAI,wDAA4C;sBACnE,eAAe;uBACd,WAAY,CAAC,IAAI;;sCAEF,2CAA+B;;;;SAI5D,CAAC;AACV,CAAC;AAvDD,8DAuDC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/compiler",
-    "version": "0.142.3",
+    "version": "0.143.0",
     "description": "Luvio Compiler",
     "repository": {
         "type": "git",
@@ -23,13 +23,13 @@
         "test:debug": "node --inspect-brk ../../../node_modules/jest/bin/jest.js --config ./jest.config.js --runInBand"
     },
     "dependencies": {
-        "@luvio/graphql-parser": "^0.142.3",
+        "@luvio/graphql-parser": "^0.143.0",
         "amf-client-js": "4.2.0"
     },
     "devDependencies": {
-        "@luvio/adapter-test-library": "^0.142.3",
-        "@luvio/engine": "^0.142.3",
-        "@luvio/graphql": "^0.142.3"
+        "@luvio/adapter-test-library": "^0.143.0",
+        "@luvio/engine": "^0.143.0",
+        "@luvio/graphql": "^0.143.0"
     },
     "volta": {
         "extends": "../../../package.json"