sakuraapi / cli Goto Github PK

Steps to reproduce

1. create a project using Sapi init sakura-test.
2. follow the description and provide inputs until JWT role
   ** What JWT role does this server fulfill?: (none)
   select i)issuer
   ? Server JWT Issuer Name: localhost
   ? Server JWT Signing Key: BbI.4DdtAuHGGYOHYWya}Ox*EF3&6+oH

then it will ask for audiences
? Audience Server Name: localhost:5050
? Audience Server Key: "=BQgkEl:rCwuj&J#vk,#wS_)Ho4zC[+

it will loop continuously there is no specified way to exit from the loop.

if I forcefully exited the process then all my actions and data loss.so here there should be a way to exit from the loop while configuring the issuer.

The point of the cli is to make it fast to set up new SakuraApi projects and to establish best practices; as such, it should include a models directory to show where models should ideally be kept.

npm WARN deprecated [email protected]: 📫 Please upgrade to v3.1.5 (v3.0.x had a core bug with attachments and v3.1.5 now supports Node v6.4.0+). Also read the breaking changes for upgrading from v2 to v3 at https://github.com/niftylettuce/email-templates#v3-breaking-changes 📫
Testing implications of upgrading versions.

• fix problem with npx jamine test
• .gitignore isn't getting copied from template for some reason
• bodyParser.json missing
• refactor / enhance how email is setup for auth authorities
• specs aren't found when npm test is run

This has become expecially important because of how mixins work (don't work?) with TypeScript 2.6 (see: microsoft/TypeScript#9944).

So, for example to get an @Model working, there's an export tap dance that needs to happen:

import {
  Db,
  IDbGetParams,
  IFromDbOptions,
  Json,
  Model,
  SakuraApi,
  SapiModelMixin
}            from '@sakuraapi/api';
import {
  Collection,
  CollectionInsertOneOptions,
  CollectionOptions,
  Cursor,
  Db as MongoDb,
  DeleteWriteOpResultObject,
  InsertOneWriteOpResult,
  ObjectID,
  ReplaceOneOptions,
  UpdateWriteOpResult
}            from 'mongodb';
import {dbs} from '../config/db';

export {
  Collection,
  CollectionInsertOneOptions,
  CollectionOptions,
  Cursor,
  MongoDb,
  DeleteWriteOpResultObject,
  InsertOneWriteOpResult,
  ObjectID,
  ReplaceOneOptions,
  UpdateWriteOpResult,
  IDbGetParams,
  IFromDbOptions,
  SakuraApi
};

@Model({
  dbConfig: dbs.user
})
export class User extends SapiModelMixin() {
}

That's a lot of setup work. It looks like TypeScript issue 9944 is scheduled to have some sort of solution in 2.8, so revisit the issue then. In the meantime, sapi cli needs to reduce the pain in setting up a model.

Might as well create generators for Services and Routables at the same time.

template-package.json/dependencies.json wasn't updated properly.

import * as environment from '../../src/config/environment';

...

  dbConnections: [
    ...(environment as any).dbConnections
  ],

This will make it less confusing when setting up databases. If an integrator wants their test environment to be totally different, they can change this, but by default setup tests to rely on the main environment file for less confusing initial configuration.

Right now, this is setup outside of the Server class in src/index.ts - it'd be better to have it in the start method, so it has access to log service.

I believe that since Boostrap().boot() is called within a try/catch block, it will catch anything that bubbles out of boot.

If you run sapi init over an existing project, it should let you diff changes. If that project was setup with jwt type none, on the second sapi init, it inserts:

    "email-templates": "^3.2.0",
    "nodemailer": "^4.0.1",
    "@types/email-templates": "^3.1.0",

into package.json. It should not unless the user changed the jwt target to auth-authority.

Template Literal is fastest, smallest and simplest template engine, because it use JS's literal template feature.

It's 55 times faster than EJS, and it also use less CPU and RAM ressources, so it may be a good idea to use it instead of EJS 😀

email-service.spec.ts was included in init command even though the source file was skipped.

Needs to be able to handle no json return from npm outdated when there are no updates.

This may be a regression...

scenario was git init with an audience server.

fix:

  private buildJsonObj(message: any, err?: Error): object {
    const obj = typeof message === 'string' ? {message} : Object.assign({}, message);

    obj.serverCity = LogService.city;
    obj.serverCountry = LogService.country;
    obj.serverExternalHostname = LogService.externalHostname;
    obj.serverHostname = LogService.hostName;
    obj.serverIp = LogService.ip;
    obj.serverNodeEnv = LogService.nodeEnv;

    if (err) {
      obj.error = errorToJsonString(err);
    } else if (message instanceof Error) {
      obj.error = errorToJsonString(message);
    }

    return obj;
  }

And remove bcrypt from scaffold

• @sakuraapi/[email protected]
• @sakuraapi/[email protected]
• @sakuraapi/[email protected]
• @sakuraapi/[email protected]

Walk through npm outdated and choose per outdated dependency whether to skip, update to wanted, or update to latest... then run unit tests... then repeat until all is done.

Update to latest core (0.19.3)
auth-native-authority (0.5.3)
auth-audience (0.3.4)

It should be config-api.ts

This should be able to parse existing environment json and ts files for both spec config and normal config to add, edit, delete DB config.

Ideally, it would expect various config files to be in a particular place, but would allow you to designate alternative paths if files aren't where they're expected to be. One example of this would be the dbs.ts file.

On the TS side of things, some kind of AST parsing would be nice: http://blog.scottlogic.com/2017/05/02/typescript-compiler-api-revisited.html

$ sapi init aaaa
SakuraAPI Cli v0.6.3
Initialized empty Git repository in /Users/daniel/Documents/projects/sandbox/aaaa/.git/
✓ Loaded default preferences from /Users/daniel/.sapi
package.json preferences:
? Author: daniel
? Description: SakuraApi Awesome Sauce
? License: UNLICENSED
? Project Name (npm name): aaaa
? Version: 0.0.0
src/config/environment.ts preferences:
? What JWT role does this server fulfill?: (none) issuer
? Server JWT Issuer Name issuer.Daniels-MacBook-Pro.local
? Server JWT Signing Key: @',7>QOwPt~DTFE>i#>g~a,%(!579tu[

see the second character of the generated signingKey

This will cause the generated project not to npm start