Updated npm configuration to use new typescript2 typings system

This also removes the dependency to the typings project.
Issue #4761
This commit is contained in:
Sebastian List 2017-02-14 11:04:23 +01:00 committed by wing328
parent 45519c521c
commit f760d93cd7
15 changed files with 210 additions and 110 deletions

View File

@ -28,9 +28,37 @@ _unPublished (not recommended):_
npm install PATH_TO_GENERATED_PACKAGE --save
```
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:
```
npm link
```
In your project:
```
npm link {{npmName}}@{{npmVersion}}
```
In your angular2 project:
TODO: paste example.
```
import { DefaultApi } from '{{npmName}}/api/api';
@NgModule({
imports: [],
declarations: [],
exports: [],
providers: [AppModule]
})
export class CoreModule {}
```
```
import { DefaultApi } from '{{npmName}}/api/api';
export class AppComponent {
constructor(private apiGateway: DefaultApi) { }
}
```
### Set service base path
If different than the generated base path, during app bootstrap, you can provide the base path to your service.
@ -41,4 +69,30 @@ import { BASE_PATH } from './path-to-swagger-gen-service/index';
bootstrap(AppComponent, [
{ provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);
```
#### Using @angular/cli
First extend your `src/environments/*.ts` files by adding the corresponding base path:
```
export const environment = {
production: false,
API_BASE_PATH: 'http://127.0.0.1:8080'
};
```
In the src/app/app.module.ts:
```
import { BASE_PATH } from '{{npmName}}';
import { environment } from '../environments/environment';
@NgModule({
declarations: [
AppComponent,
],
imports: [ ],
providers: [{ provide: BASE_PATH, useValue: useValue: environment.API_BASE_PATH }],
bootstrap: [AppComponent]
})
export class AppModule { }
```

View File

@ -10,31 +10,29 @@
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "typings install && tsc --outDir dist/",
"build": "tsc",
"postinstall": "npm run build"
},
"peerDependencies": {
"@angular/core": "^2.0.0-rc.5",
"@angular/http": "^2.0.0-rc.5",
"@angular/common": "^2.0.0-rc.5",
"@angular/compiler": "^2.0.0-rc.5",
"@angular/core": "^2.2.2",
"@angular/http": "^2.2.2",
"@angular/common": "^2.2.2",
"@angular/compiler": "^2.2.2",
"core-js": "^2.4.0",
"reflect-metadata": "^0.1.3",
"rxjs": "5.0.0-beta.6",
"zone.js": "^0.6.17"
"rxjs": "^5.1.0",
"zone.js": "^0.7.6"
},
"devDependencies": {
"@angular/core": "^2.0.0-rc.5",
"@angular/http": "^2.0.0-rc.5",
"@angular/common": "^2.0.0-rc.5",
"@angular/compiler": "^2.0.0-rc.5",
"@angular/platform-browser": "^2.0.0-rc.5",
"core-js": "^2.4.0",
"@angular/core": "^2.2.2",
"@angular/http": "^2.2.2",
"@angular/common": "^2.2.2",
"@angular/compiler": "^2.2.2",
"@angular/platform-browser": "^2.2.2",
"reflect-metadata": "^0.1.3",
"rxjs": "5.0.0-beta.6",
"zone.js": "^0.6.17",
"typescript": "^1.8.10",
"typings": "^1.3.2"
"rxjs": "5.1.0",
"zone.js": "^0.7.6",
"typescript": "^2.1.5"
}{{#npmRepository}},{{/npmRepository}}
{{#npmRepository}}
"publishConfig":{

View File

@ -5,23 +5,21 @@
"noImplicitAny": false,
"suppressImplicitAnyIndexErrors": true,
"target": "es5",
"module": "commonjs",
"module": "es6",
"moduleResolution": "node",
"removeComments": true,
"sourceMap": true,
"outDir": "./dist",
"noLib": false,
"declaration": true
"declaration": true,
"lib": [ "es6", "dom" ]
},
"exclude": [
"node_modules",
"typings/main.d.ts",
"typings/main",
"dist"
],
"filesGlob": [
"./model/*.ts",
"./api/*.ts",
"typings/browser.d.ts"
"./api/*.ts"
]
}

View File

@ -191,13 +191,13 @@ export class PetApi {
}
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -253,7 +253,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -304,7 +304,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -355,7 +355,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -403,7 +403,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -442,13 +442,13 @@ export class PetApi {
}
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -504,7 +504,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -126,7 +126,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -202,7 +202,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -240,7 +240,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -191,7 +191,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -232,7 +232,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -273,7 +273,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -315,7 +315,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -354,7 +354,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -405,7 +405,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -438,7 +438,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -482,7 +482,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -28,9 +28,37 @@ _unPublished (not recommended):_
npm install PATH_TO_GENERATED_PACKAGE --save
```
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:
```
npm link
```
In your project:
```
npm link @swagger/angular2-typescript-petstore@0.0.1
```
In your angular2 project:
TODO: paste example.
```
import { DefaultApi } from '@swagger/angular2-typescript-petstore/api/api';
@NgModule({
imports: [],
declarations: [],
exports: [],
providers: [AppModule]
})
export class CoreModule {}
```
```
import { DefaultApi } from '@swagger/angular2-typescript-petstore/api/api';
export class AppComponent {
constructor(private apiGateway: DefaultApi) { }
}
```
### Set service base path
If different than the generated base path, during app bootstrap, you can provide the base path to your service.
@ -41,4 +69,30 @@ import { BASE_PATH } from './path-to-swagger-gen-service/index';
bootstrap(AppComponent, [
{ provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);
```
#### Using @angular/cli
First extend your `src/environments/*.ts` files by adding the corresponding base path:
```
export const environment = {
production: false,
API_BASE_PATH: 'http://127.0.0.1:8080'
};
```
In the src/app/app.module.ts:
```
import { BASE_PATH } from '@swagger/angular2-typescript-petstore';
import { environment } from '../environments/environment';
@NgModule({
declarations: [
AppComponent,
],
imports: [ ],
providers: [{ provide: BASE_PATH, useValue: useValue: environment.API_BASE_PATH }],
bootstrap: [AppComponent]
})
export class AppModule { }
```

View File

@ -191,13 +191,13 @@ export class PetApi {
}
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -253,7 +253,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -304,7 +304,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -355,7 +355,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -403,7 +403,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -442,13 +442,13 @@ export class PetApi {
}
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -504,7 +504,7 @@ export class PetApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -126,7 +126,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -202,7 +202,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -240,7 +240,7 @@ export class StoreApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -191,7 +191,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -232,7 +232,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -273,7 +273,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -315,7 +315,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -354,7 +354,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -405,7 +405,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -438,7 +438,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];
@ -482,7 +482,7 @@ export class UserApi {
// to determine the Accept header
let produces: string[] = [
'application/xml',
'application/xml',
'application/json'
];

View File

@ -10,31 +10,29 @@
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "typings install && tsc --outDir dist/",
"build": "tsc",
"postinstall": "npm run build"
},
"peerDependencies": {
"@angular/core": "^2.0.0-rc.5",
"@angular/http": "^2.0.0-rc.5",
"@angular/common": "^2.0.0-rc.5",
"@angular/compiler": "^2.0.0-rc.5",
"@angular/core": "^2.2.2",
"@angular/http": "^2.2.2",
"@angular/common": "^2.2.2",
"@angular/compiler": "^2.2.2",
"core-js": "^2.4.0",
"reflect-metadata": "^0.1.3",
"rxjs": "5.0.0-beta.6",
"zone.js": "^0.6.17"
"rxjs": "^5.1.0",
"zone.js": "^0.7.6"
},
"devDependencies": {
"@angular/core": "^2.0.0-rc.5",
"@angular/http": "^2.0.0-rc.5",
"@angular/common": "^2.0.0-rc.5",
"@angular/compiler": "^2.0.0-rc.5",
"@angular/platform-browser": "^2.0.0-rc.5",
"core-js": "^2.4.0",
"@angular/core": "^2.2.2",
"@angular/http": "^2.2.2",
"@angular/common": "^2.2.2",
"@angular/compiler": "^2.2.2",
"@angular/platform-browser": "^2.2.2",
"reflect-metadata": "^0.1.3",
"rxjs": "5.0.0-beta.6",
"zone.js": "^0.6.17",
"typescript": "^1.8.10",
"typings": "^1.3.2"
"rxjs": "5.1.0",
"zone.js": "^0.7.6",
"typescript": "^2.1.5"
},
"publishConfig":{
"registry":"https://skimdb.npmjs.com/registry"

View File

@ -5,23 +5,21 @@
"noImplicitAny": false,
"suppressImplicitAnyIndexErrors": true,
"target": "es5",
"module": "commonjs",
"module": "es6",
"moduleResolution": "node",
"removeComments": true,
"sourceMap": true,
"outDir": "./dist",
"noLib": false,
"declaration": true
"declaration": true,
"lib": [ "es6", "dom" ]
},
"exclude": [
"node_modules",
"typings/main.d.ts",
"typings/main",
"dist"
],
"filesGlob": [
"./model/*.ts",
"./api/*.ts",
"typings/browser.d.ts"
"./api/*.ts"
]
}

View File

@ -188,13 +188,13 @@ export class PetApi implements PetApiInterface {
let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -250,7 +250,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -299,7 +299,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -348,7 +348,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -396,7 +396,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -440,13 +440,13 @@ export class PetApi implements PetApiInterface {
let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
// to determine the Content-Type header
let consumes: string[] = [
'application/json',
'application/json',
'application/xml'
];
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -502,7 +502,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -566,7 +566,7 @@ export class PetApi implements PetApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];

View File

@ -127,7 +127,7 @@ export class StoreApi implements StoreApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -160,7 +160,7 @@ export class StoreApi implements StoreApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -204,7 +204,7 @@ export class StoreApi implements StoreApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -238,7 +238,7 @@ export class StoreApi implements StoreApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];

View File

@ -188,7 +188,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -225,7 +225,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -262,7 +262,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -304,7 +304,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -343,7 +343,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -386,7 +386,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -419,7 +419,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];
@ -459,7 +459,7 @@ export class UserApi implements UserApiInterface {
// to determine the Accept header
let produces: string[] = [
'application/json',
'application/json',
'application/xml'
];