Feat/106 typescript language bindings (#107)

added typescript gbfs v3.0 language bindings

.gitignore

@@ -84,4 +84,7 @@ build/
 
 # Mac
 */.DS_Store
-.DS_Store
+.DS_Store
+
+# Node Modules
+models/typescript/node_modules/*

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+Want to contribute? Great! First, read this page (including the small print at the end).
+
+### Before you contribute
+Before we can use your code, you must sign the
+[MobilityData Individual Contributor License Agreement](https://gist.github.com/barbeau/c4c2b76c40d08db13b6a58bf52666e86#file-mobilitydata-contributor-license-agreement-agreement)
+(CLA), which you can do online by clicking on a link after you open a pull request. 
+The CLA is necessary mainly because you own the copyright to your changes, even 
+after your contribution becomes part of our codebase, so we need your permission 
+to use and distribute your code. We also need to be sure of various other things—
+for instance that you'll tell us if you know that your code infringes on other 
+people's patents. You don't have to sign the CLA until after you've submitted your 
+code for review and a member has approved it, but you must do it before we can put 
+your code into our codebase. Before you start working on a larger contribution, you 
+should get in touch with us first through the issue tracker with your idea so that we 
+can help out and possibly guide you. Coordinating up front makes it much easier to avoid
+frustration later on.
+
+### Code reviews
+All submissions, including submissions by project members, require review. We
+use Github pull requests for this purpose.

README.md

@@ -1,2 +1,11 @@
 # gbfs-json-schema
 JSON Schema for [General Bikeshare Feed Specification(GBFS)](https://github.com/MobilityData/gbfs/blob/master/gbfs.md)  feeds, managed by MobilityData. The [gbfs-validator](https://github.com/MobilityData/gbfs-validator) links directly to them.
+
+## Language Bindings
+
+* [TypeScript ](models/typescript/README.md)
+
+Are we missing your favorite language? Consider contributing:
+
+1. Read [CONTRIBUTING.md](CONTRIBUTING.md).
+2. Open a pull request with your language of choice. Please include update instructions (ideally, scripts). Also, provide packaging suitable for the language ecosystem.

models/typescript/README.md

@@ -0,0 +1,40 @@
+# Typescript GBFS Language Bindings
+
+[![npm version](https://badge.fury.io/js/gbfs-typescript-types.svg)](http://badge.fury.io/js/gbfs-typescript-types)
+
+TypeScript types for parsing and working with General Bikeshare Feed Specification (GBFS) data, ensuring type safety and code consistency in TypeScript projects.
+
+## Add the Dependency
+
+To use `gbfs-typescript-types` in your own project, you need to
+first install our [Node.js npm package](https://www.npmjs.com/package/gbfs-typescript-types):
+
+```
+npm install gbfs-typescript-types --save-dev
+```
+
+## Versions
+Currently only version 3.0 of GBFS is supported
+
+## Example Code
+```typescript
+// top level import
+import { v3 } from './';
+
+// high level types
+import { SystemInformation } from './v3.0';
+
+// lower level properties need to have path specified
+import { Data as SystemInformationData } from './v3.0/system_information';
+import { Data as VehicleStatusData } from './v3.0/vehicle_status';
+
+let vehicleStatus: v3.VehicleStatus;
+let systemInformationData: SystemInformationData;
+const url = "https://data-sharing.tier-services.io/tier_paris/gbfs/3.0/system-information";
+fetch(url).then((systemInformationResponse) => {
+    systemInformationResponse.json().then((systemInformationJson: SystemInformation) => {
+        systemInformationJson // will have access to types
+        systemInformationData = systemInformationJson.data;
+    })
+})
+```

models/typescript/index.d.ts

@@ -0,0 +1 @@
+export * as v3 from './v3.0';

models/typescript/jest.config.js

@@ -0,0 +1,8 @@
+// jest.config.js
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    moduleNameMapper: {
+        '^@/(.*)$': '<rootDir>/$1',
+    },
+};

models/typescript/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "gbfs-typescript-types",
+  "version": "1.0.0",
+  "description": "Language Bindings for GBFS in Typescript",
+  "types": "index.d.ts",
+  "scripts": {
+    "generate_typescript_v3.0": "./scripts/generate_types.sh 3.0"
+  },
+  "author": "MobilityData",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "quicktype": "^23.0.145",
+    "ts-interface-builder": "^0.3.3",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "ts-interface-checker": "^1.0.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MobilityData/gbfs-json-schema.git"
+  },
+  "bugs": {
+    "url": "https://github.com/MobilityData/gbfs-json-schema/issues"
+  },
+  "licenses": [
+    {
+      "type": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ]
+}

models/typescript/scripts/copyright.txt

@@ -0,0 +1,14 @@
+// Copyright 2024 MobilityData
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+

models/typescript/scripts/generate_types.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# This script generates typescript interfaces from the gbfs schemas (npx quicktype)
+# It also generates files that help with testing the generated interfaces (npx ts-interface-builder)
+# It takes the gbfs version number as an argument
+# Using this script can be done as follows: ./scripts/generate_types.sh 3.0
+# Just make sure to have the gbfs schemas in the correct folder ./vX.X
+
+gbfs_version="v$1" #$1 is the first argument passed to the script (the version number)
+parent_dir="$(dirname "$(dirname "$0")")"
+folder_path="../../$parent_dir/$gbfs_version/"
+output_path="$parent_dir/$gbfs_version/"
+test_path="$parent_dir/$gbfs_version/tests/ti/"
+copyright_file="$parent_dir/scripts/copyright.txt"
+
+# Iterate over all the files in the folder of the gbfs version
+for file in "$folder_path"/*
+do
+    # Extract the file name from the path and add it to the array
+    file_name=$(basename "$file")
+    file_name_no_extension="${file_name%.*}"
+    echo $file_name_no_extension
+
+    output_file="$output_path$file_name_no_extension"
+
+    # generates model files from schema files
+    npx quicktype -s schema "$folder_path$file_name" -o "$output_file.ts" --prefer-unions --just-types
+
+    # JSON cannot represent Date objects, so manually change Date to string
+    sed -i "" "s/Date;/string;/g" "$output_file.ts"
+
+    # generates files for typescript testing
+    npx ts-interface-builder "$output_file.ts" -o $test_path
+
+    # renames the generated file to .d.ts as it's a declaration file
+    # cannot be done right away to .d.ts as it messes up the name of the interfaces
+    mv "$output_file.ts" "$output_file.d.ts"
+
+    # Inject copyright text at the top of the file
+    temp_file=$(mktemp)
+    cat "$copyright_file" "$output_file.d.ts" > "$temp_file"
+    mv "$temp_file" "$output_file.d.ts"
+done

models/typescript/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}