@graphql-codegen/c-sharp-common 0.0.0

package/cjs/c-sharp-declaration-block.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CSharpDeclarationBlock = void 0;
+const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
+const utils_js_1 = require("./utils.js");
+class CSharpDeclarationBlock {
+    constructor() {
+        this._name = null;
+        this._extendStr = [];
+        this._implementsStr = [];
+        this._kind = null;
+        this._access = 'public';
+        this._final = false;
+        this._static = false;
+        this._block = null;
+        this._comment = null;
+        this._nestedClasses = [];
+    }
+    nestedClass(nstCls) {
+        this._nestedClasses.push(nstCls);
+        return this;
+    }
+    access(access) {
+        this._access = access;
+        return this;
+    }
+    asKind(kind) {
+        this._kind = kind;
+        return this;
+    }
+    final() {
+        this._final = true;
+        return this;
+    }
+    static() {
+        this._static = true;
+        return this;
+    }
+    withComment(comment) {
+        if (comment) {
+            this._comment = (0, utils_js_1.transformComment)(comment, 1);
+        }
+        return this;
+    }
+    withBlock(block) {
+        this._block = block;
+        return this;
+    }
+    extends(extendStr) {
+        this._extendStr = extendStr;
+        return this;
+    }
+    implements(implementsStr) {
+        this._implementsStr = implementsStr;
+        return this;
+    }
+    withName(name) {
+        this._name = typeof name === 'object' ? name.value : name;
+        return this;
+    }
+    get string() {
+        let result = '';
+        if (this._kind) {
+            let name = '';
+            if (this._name) {
+                name = this._name;
+            }
+            if (this._kind === 'namespace') {
+                result += `${this._kind} ${name} `;
+            }
+            else {
+                let extendStr = '';
+                let implementsStr = '';
+                const final = this._final ? ' final' : '';
+                const isStatic = this._static ? ' static' : '';
+                if (this._extendStr.length > 0) {
+                    extendStr = ` : ${this._extendStr.join(', ')}`;
+                }
+                if (this._implementsStr.length > 0) {
+                    implementsStr = ` : ${this._implementsStr.join(', ')}`;
+                }
+                result += `${this._access}${isStatic}${final} ${this._kind} ${name}${extendStr}${implementsStr} `;
+            }
+        }
+        const nestedClasses = this._nestedClasses.length
+            ? this._nestedClasses.map(c => (0, visitor_plugin_common_1.indentMultiline)(c.string)).join('\n\n')
+            : null;
+        const before = '{';
+        const after = '}';
+        const block = [before, nestedClasses, this._block, after].filter(f => f).join('\n');
+        result += block;
+        return (this._comment ? this._comment : '') + result + '\n';
+    }
+}
+exports.CSharpDeclarationBlock = CSharpDeclarationBlock;

package/cjs/c-sharp-field-types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CSharpFieldType = void 0;
+class CSharpFieldType {
+    constructor(fieldType) {
+        Object.assign(this, fieldType);
+    }
+    get innerTypeName() {
+        const nullable = this.baseType.valueType && !this.baseType.required ? '?' : '';
+        return `${this.baseType.type}${nullable}`;
+    }
+    get isOuterTypeRequired() {
+        return this.listType ? this.listType.required : this.baseType.required;
+    }
+}
+exports.CSharpFieldType = CSharpFieldType;

package/cjs/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./c-sharp-declaration-block.js"), exports);
+tslib_1.__exportStar(require("./scalars.js"), exports);
+tslib_1.__exportStar(require("./utils.js"), exports);
+tslib_1.__exportStar(require("./c-sharp-field-types.js"), exports);
+tslib_1.__exportStar(require("./keywords.js"), exports);

package/cjs/keywords.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertSafeName = void 0;
+/**
+ * C# keywords
+ * https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/
+ */
+const csharpKeywords = new Set([
+    'abstract',
+    'as',
+    'base',
+    'bool',
+    'break',
+    'byte',
+    'case',
+    'catch',
+    'char',
+    'checked',
+    'class',
+    'const',
+    'continue',
+    'decimal',
+    'default',
+    'delegate',
+    'do',
+    'double',
+    'else',
+    'enum',
+    'event',
+    'explicit',
+    'extern',
+    'false',
+    'finally',
+    'fixed',
+    'float',
+    'for',
+    'foreach',
+    'goto',
+    'if',
+    'implicit',
+    'in',
+    'int',
+    'interface',
+    'internal',
+    'is',
+    'lock',
+    'long',
+    'namespace',
+    'new',
+    'null',
+    'object',
+    'operator',
+    'out',
+    'override',
+    'params',
+    'private',
+    'protected',
+    'public',
+    'readonly',
+    'record',
+    'ref',
+    'return',
+    'sbyte',
+    'sealed',
+    'short',
+    'sizeof',
+    'stackalloc',
+    'static',
+    'string',
+    'struct',
+    'switch',
+    'this',
+    'throw',
+    'true',
+    'try',
+    'typeof',
+    'uint',
+    'ulong',
+    'unchecked',
+    'unsafe',
+    'ushort',
+    'using',
+    'virtual',
+    'void',
+    'volatile',
+    'while',
+]);
+/**
+ * Checks name against list of keywords. If it is, will prefix value with @
+ *
+ * Note:
+ * This class should first invoke the convertName from base-visitor to convert the string or node
+ * value according the naming configuration, eg upper or lower case. Then resulting string checked
+ * against the list or keywords.
+ * However the generated C# code is not yet able to handle fields that are in a different case so
+ * the invocation of convertName is omitted purposely.
+ */
+function convertSafeName(node) {
+    const name = typeof node === 'string' ? node : node.value;
+    return csharpKeywords.has(name) ? `@${name}` : name;
+}
+exports.convertSafeName = convertSafeName;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/scalars.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.csharpValueTypes = exports.C_SHARP_SCALARS = void 0;
+exports.C_SHARP_SCALARS = {
+    ID: 'string',
+    String: 'string',
+    Boolean: 'bool',
+    Int: 'int',
+    Float: 'double',
+    Date: 'DateTime',
+};
+exports.csharpValueTypes = [
+    'bool',
+    'byte',
+    'sbyte',
+    'char',
+    'decimal',
+    'double',
+    'float',
+    'int',
+    'uint',
+    'long',
+    'ulong',
+    'short',
+    'ushort',
+    'DateTime',
+];

package/cjs/utils.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapFieldType = exports.getListInnerTypeNode = exports.getListTypeDepth = exports.getListTypeField = exports.isValueType = exports.transformComment = void 0;
+// This file is bundled and inlined.
+// We should probably make this a shared package though.
+// eslint-disable-next-line import/no-extraneous-dependencies
+const graphql_1 = require("graphql");
+// eslint-disable-next-line import/no-extraneous-dependencies
+const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
+const scalars_js_1 = require("./scalars.js");
+function transformComment(comment, indentLevel = 0) {
+    if (!comment) {
+        return '';
+    }
+    if (isStringValueNode(comment)) {
+        comment = comment.value;
+    }
+    comment = comment.trimStart().split('*/').join('*\\/');
+    let lines = comment.split('\n');
+    lines = ['/// <summary>', ...lines.map(line => `/// ${line}`), '/// </summary>'];
+    return lines
+        .map(line => (0, visitor_plugin_common_1.indent)(line, indentLevel))
+        .concat('')
+        .join('\n');
+}
+exports.transformComment = transformComment;
+function isStringValueNode(node) {
+    return node && typeof node === 'object' && node.kind === graphql_1.Kind.STRING;
+}
+function isValueType(type) {
+    // Limitation: only checks the list of known built in value types
+    // Eg .NET types and struct types won't be detected correctly
+    return scalars_js_1.csharpValueTypes.includes(type);
+}
+exports.isValueType = isValueType;
+function getListTypeField(typeNode) {
+    if (typeNode.kind === graphql_1.Kind.LIST_TYPE) {
+        return {
+            required: false,
+            type: getListTypeField(typeNode.type),
+        };
+    }
+    if (typeNode.kind === graphql_1.Kind.NON_NULL_TYPE && typeNode.type.kind === graphql_1.Kind.LIST_TYPE) {
+        return Object.assign(getListTypeField(typeNode.type), {
+            required: true,
+        });
+    }
+    if (typeNode.kind === graphql_1.Kind.NON_NULL_TYPE) {
+        return getListTypeField(typeNode.type);
+    }
+    return undefined;
+}
+exports.getListTypeField = getListTypeField;
+function getListTypeDepth(listType) {
+    if (listType) {
+        return getListTypeDepth(listType.type) + 1;
+    }
+    return 0;
+}
+exports.getListTypeDepth = getListTypeDepth;
+function getListInnerTypeNode(typeNode) {
+    if (typeNode.kind === graphql_1.Kind.LIST_TYPE) {
+        return getListInnerTypeNode(typeNode.type);
+    }
+    if (typeNode.kind === graphql_1.Kind.NON_NULL_TYPE && typeNode.type.kind === graphql_1.Kind.LIST_TYPE) {
+        return getListInnerTypeNode(typeNode.type);
+    }
+    return typeNode;
+}
+exports.getListInnerTypeNode = getListInnerTypeNode;
+function wrapFieldType(fieldType, listTypeField, listType = 'IEnumerable') {
+    if (listTypeField) {
+        const innerType = wrapFieldType(fieldType, listTypeField.type, listType);
+        return `${listType}<${innerType}>`;
+    }
+    return fieldType.innerTypeName;
+}
+exports.wrapFieldType = wrapFieldType;

package/esm/c-sharp-declaration-block.js

@@ -0,0 +1,91 @@
+import { indentMultiline } from '@graphql-codegen/visitor-plugin-common';
+import { transformComment } from './utils.js';
+export class CSharpDeclarationBlock {
+    constructor() {
+        this._name = null;
+        this._extendStr = [];
+        this._implementsStr = [];
+        this._kind = null;
+        this._access = 'public';
+        this._final = false;
+        this._static = false;
+        this._block = null;
+        this._comment = null;
+        this._nestedClasses = [];
+    }
+    nestedClass(nstCls) {
+        this._nestedClasses.push(nstCls);
+        return this;
+    }
+    access(access) {
+        this._access = access;
+        return this;
+    }
+    asKind(kind) {
+        this._kind = kind;
+        return this;
+    }
+    final() {
+        this._final = true;
+        return this;
+    }
+    static() {
+        this._static = true;
+        return this;
+    }
+    withComment(comment) {
+        if (comment) {
+            this._comment = transformComment(comment, 1);
+        }
+        return this;
+    }
+    withBlock(block) {
+        this._block = block;
+        return this;
+    }
+    extends(extendStr) {
+        this._extendStr = extendStr;
+        return this;
+    }
+    implements(implementsStr) {
+        this._implementsStr = implementsStr;
+        return this;
+    }
+    withName(name) {
+        this._name = typeof name === 'object' ? name.value : name;
+        return this;
+    }
+    get string() {
+        let result = '';
+        if (this._kind) {
+            let name = '';
+            if (this._name) {
+                name = this._name;
+            }
+            if (this._kind === 'namespace') {
+                result += `${this._kind} ${name} `;
+            }
+            else {
+                let extendStr = '';
+                let implementsStr = '';
+                const final = this._final ? ' final' : '';
+                const isStatic = this._static ? ' static' : '';
+                if (this._extendStr.length > 0) {
+                    extendStr = ` : ${this._extendStr.join(', ')}`;
+                }
+                if (this._implementsStr.length > 0) {
+                    implementsStr = ` : ${this._implementsStr.join(', ')}`;
+                }
+                result += `${this._access}${isStatic}${final} ${this._kind} ${name}${extendStr}${implementsStr} `;
+            }
+        }
+        const nestedClasses = this._nestedClasses.length
+            ? this._nestedClasses.map(c => indentMultiline(c.string)).join('\n\n')
+            : null;
+        const before = '{';
+        const after = '}';
+        const block = [before, nestedClasses, this._block, after].filter(f => f).join('\n');
+        result += block;
+        return (this._comment ? this._comment : '') + result + '\n';
+    }
+}

package/esm/c-sharp-field-types.js

@@ -0,0 +1,12 @@
+export class CSharpFieldType {
+    constructor(fieldType) {
+        Object.assign(this, fieldType);
+    }
+    get innerTypeName() {
+        const nullable = this.baseType.valueType && !this.baseType.required ? '?' : '';
+        return `${this.baseType.type}${nullable}`;
+    }
+    get isOuterTypeRequired() {
+        return this.listType ? this.listType.required : this.baseType.required;
+    }
+}

package/esm/index.js

@@ -0,0 +1,5 @@
+export * from './c-sharp-declaration-block.js';
+export * from './scalars.js';
+export * from './utils.js';
+export * from './c-sharp-field-types.js';
+export * from './keywords.js';

package/esm/keywords.js

@@ -0,0 +1,98 @@
+/**
+ * C# keywords
+ * https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/
+ */
+const csharpKeywords = new Set([
+    'abstract',
+    'as',
+    'base',
+    'bool',
+    'break',
+    'byte',
+    'case',
+    'catch',
+    'char',
+    'checked',
+    'class',
+    'const',
+    'continue',
+    'decimal',
+    'default',
+    'delegate',
+    'do',
+    'double',
+    'else',
+    'enum',
+    'event',
+    'explicit',
+    'extern',
+    'false',
+    'finally',
+    'fixed',
+    'float',
+    'for',
+    'foreach',
+    'goto',
+    'if',
+    'implicit',
+    'in',
+    'int',
+    'interface',
+    'internal',
+    'is',
+    'lock',
+    'long',
+    'namespace',
+    'new',
+    'null',
+    'object',
+    'operator',
+    'out',
+    'override',
+    'params',
+    'private',
+    'protected',
+    'public',
+    'readonly',
+    'record',
+    'ref',
+    'return',
+    'sbyte',
+    'sealed',
+    'short',
+    'sizeof',
+    'stackalloc',
+    'static',
+    'string',
+    'struct',
+    'switch',
+    'this',
+    'throw',
+    'true',
+    'try',
+    'typeof',
+    'uint',
+    'ulong',
+    'unchecked',
+    'unsafe',
+    'ushort',
+    'using',
+    'virtual',
+    'void',
+    'volatile',
+    'while',
+]);
+/**
+ * Checks name against list of keywords. If it is, will prefix value with @
+ *
+ * Note:
+ * This class should first invoke the convertName from base-visitor to convert the string or node
+ * value according the naming configuration, eg upper or lower case. Then resulting string checked
+ * against the list or keywords.
+ * However the generated C# code is not yet able to handle fields that are in a different case so
+ * the invocation of convertName is omitted purposely.
+ */
+export function convertSafeName(node) {
+    const name = typeof node === 'string' ? node : node.value;
+    return csharpKeywords.has(name) ? `@${name}` : name;
+}

package/esm/scalars.js

@@ -0,0 +1,24 @@
+export const C_SHARP_SCALARS = {
+    ID: 'string',
+    String: 'string',
+    Boolean: 'bool',
+    Int: 'int',
+    Float: 'double',
+    Date: 'DateTime',
+};
+export const csharpValueTypes = [
+    'bool',
+    'byte',
+    'sbyte',
+    'char',
+    'decimal',
+    'double',
+    'float',
+    'int',
+    'uint',
+    'long',
+    'ulong',
+    'short',
+    'ushort',
+    'DateTime',
+];

package/esm/utils.js

@@ -0,0 +1,69 @@
+// This file is bundled and inlined.
+// We should probably make this a shared package though.
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Kind } from 'graphql';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { indent } from '@graphql-codegen/visitor-plugin-common';
+import { csharpValueTypes } from './scalars.js';
+export function transformComment(comment, indentLevel = 0) {
+    if (!comment) {
+        return '';
+    }
+    if (isStringValueNode(comment)) {
+        comment = comment.value;
+    }
+    comment = comment.trimStart().split('*/').join('*\\/');
+    let lines = comment.split('\n');
+    lines = ['/// <summary>', ...lines.map(line => `/// ${line}`), '/// </summary>'];
+    return lines
+        .map(line => indent(line, indentLevel))
+        .concat('')
+        .join('\n');
+}
+function isStringValueNode(node) {
+    return node && typeof node === 'object' && node.kind === Kind.STRING;
+}
+export function isValueType(type) {
+    // Limitation: only checks the list of known built in value types
+    // Eg .NET types and struct types won't be detected correctly
+    return csharpValueTypes.includes(type);
+}
+export function getListTypeField(typeNode) {
+    if (typeNode.kind === Kind.LIST_TYPE) {
+        return {
+            required: false,
+            type: getListTypeField(typeNode.type),
+        };
+    }
+    if (typeNode.kind === Kind.NON_NULL_TYPE && typeNode.type.kind === Kind.LIST_TYPE) {
+        return Object.assign(getListTypeField(typeNode.type), {
+            required: true,
+        });
+    }
+    if (typeNode.kind === Kind.NON_NULL_TYPE) {
+        return getListTypeField(typeNode.type);
+    }
+    return undefined;
+}
+export function getListTypeDepth(listType) {
+    if (listType) {
+        return getListTypeDepth(listType.type) + 1;
+    }
+    return 0;
+}
+export function getListInnerTypeNode(typeNode) {
+    if (typeNode.kind === Kind.LIST_TYPE) {
+        return getListInnerTypeNode(typeNode.type);
+    }
+    if (typeNode.kind === Kind.NON_NULL_TYPE && typeNode.type.kind === Kind.LIST_TYPE) {
+        return getListInnerTypeNode(typeNode.type);
+    }
+    return typeNode;
+}
+export function wrapFieldType(fieldType, listTypeField, listType = 'IEnumerable') {
+    if (listTypeField) {
+        const innerType = wrapFieldType(fieldType, listTypeField.type, listType);
+        return `${listType}<${innerType}>`;
+    }
+    return fieldType.innerTypeName;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@graphql-codegen/c-sharp-common",
+  "version": "0.0.0",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "graphql-tag": "2.12.6"
+  },
+  "dependencies": {
+    "@graphql-codegen/plugin-helpers": "^2.4.0",
+    "@graphql-codegen/visitor-plugin-common": "^2.9.1",
+    "auto-bind": "~4.0.0",
+    "change-case-all": "1.0.14",
+    "tslib": "~2.4.0"
+  },
+  "repository": "git@github.com:dotansimha/graphql-code-generator.git",
+  "license": "MIT",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
+  "typescript": {
+    "definition": "typings/index.d.ts"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
+}

package/typings/c-sharp-declaration-block.d.ts

@@ -0,0 +1,26 @@
+import { StringValueNode, NameNode } from 'graphql';
+export declare type Access = 'private' | 'public' | 'protected';
+export declare type Kind = 'namespace' | 'class' | 'record' | 'interface' | 'enum';
+export declare class CSharpDeclarationBlock {
+    _name: string;
+    _extendStr: string[];
+    _implementsStr: string[];
+    _kind: Kind;
+    _access: Access;
+    _final: boolean;
+    _static: boolean;
+    _block: any;
+    _comment: any;
+    _nestedClasses: CSharpDeclarationBlock[];
+    nestedClass(nstCls: CSharpDeclarationBlock): CSharpDeclarationBlock;
+    access(access: Access): CSharpDeclarationBlock;
+    asKind(kind: Kind): CSharpDeclarationBlock;
+    final(): CSharpDeclarationBlock;
+    static(): CSharpDeclarationBlock;
+    withComment(comment: string | StringValueNode | null): CSharpDeclarationBlock;
+    withBlock(block: string): CSharpDeclarationBlock;
+    extends(extendStr: string[]): CSharpDeclarationBlock;
+    implements(implementsStr: string[]): CSharpDeclarationBlock;
+    withName(name: string | NameNode): CSharpDeclarationBlock;
+    get string(): string;
+}

package/typings/c-sharp-field-types.d.ts

@@ -0,0 +1,20 @@
+export interface BaseTypeField {
+    type: string;
+    valueType: boolean;
+    required: boolean;
+}
+export interface ListTypeField {
+    required: boolean;
+    type: ListTypeField;
+}
+export interface CSharpField {
+    baseType: BaseTypeField;
+    listType?: ListTypeField;
+}
+export declare class CSharpFieldType implements CSharpField {
+    baseType: BaseTypeField;
+    listType?: ListTypeField;
+    constructor(fieldType: CSharpField);
+    get innerTypeName(): string;
+    get isOuterTypeRequired(): boolean;
+}

package/typings/index.d.ts

@@ -0,0 +1,5 @@
+export * from './c-sharp-declaration-block.js';
+export * from './scalars.js';
+export * from './utils.js';
+export * from './c-sharp-field-types.js';
+export * from './keywords.js';

package/typings/keywords.d.ts

@@ -0,0 +1,12 @@
+import { NameNode } from 'graphql';
+/**
+ * Checks name against list of keywords. If it is, will prefix value with @
+ *
+ * Note:
+ * This class should first invoke the convertName from base-visitor to convert the string or node
+ * value according the naming configuration, eg upper or lower case. Then resulting string checked
+ * against the list or keywords.
+ * However the generated C# code is not yet able to handle fields that are in a different case so
+ * the invocation of convertName is omitted purposely.
+ */
+export declare function convertSafeName(node: NameNode | string): string;

package/typings/scalars.d.ts

@@ -0,0 +1,9 @@
+export declare const C_SHARP_SCALARS: {
+    ID: string;
+    String: string;
+    Boolean: string;
+    Int: string;
+    Float: string;
+    Date: string;
+};
+export declare const csharpValueTypes: string[];

package/typings/utils.d.ts

@@ -0,0 +1,8 @@
+import { TypeNode, StringValueNode } from 'graphql';
+import { ListTypeField, CSharpFieldType } from './c-sharp-field-types.js';
+export declare function transformComment(comment: string | StringValueNode, indentLevel?: number): string;
+export declare function isValueType(type: string): boolean;
+export declare function getListTypeField(typeNode: TypeNode): ListTypeField | undefined;
+export declare function getListTypeDepth(listType: ListTypeField): number;
+export declare function getListInnerTypeNode(typeNode: TypeNode): TypeNode;
+export declare function wrapFieldType(fieldType: CSharpFieldType, listTypeField?: ListTypeField, listType?: string): string;