Unverified Commit 9259dc3b authored by Rodrigo Nascimento's avatar Rodrigo Nascimento
Browse files

Merge apps-ts-definition to apps-engine

parent c6d526e0
......@@ -20,7 +20,7 @@ The development tools provide a command to quickly scaffold a new Rocket.Chat Ap
### App description
The app description file, named `app.json`, contains basic information about the app. You can check the [app-schema.json](https://github.com/RocketChat/Rocket.Chat.Apps-ts-definition/blob/master/src/app-schema.json) file for all the detailed information and fields allowed in the app description file, the basic structure is similar to this:
The app description file, named `app.json`, contains basic information about the app. You can check the [app-schema.json](https://github.com/RocketChat/Rocket.Chat.Apps-engine/blob/master/src/definition/app-schema.json) file for all the detailed information and fields allowed in the app description file, the basic structure is similar to this:
```
{
......@@ -41,7 +41,7 @@ The app description file, named `app.json`, contains basic information about the
### Extending the App class
The basic creation of an App is based on extending the `App` class from the Rocket.Chat Apps _ts-definition_ library. Your class also has to implement the constructor and optionally the `initialize` function, for more details on those check the [App definition documentation](https://rocketchat.github.io/Rocket.Chat.Apps-ts-definition/classes/app.html).
The basic creation of an App is based on extending the `App` class from the Rocket.Chat Apps _definition_ library. Your class also has to implement the constructor and optionally the `initialize` function, for more details on those check the [App definition documentation](https://rocketchat.github.io/Rocket.Chat.Apps-engine/classes/app.html).
```
import {
......@@ -49,9 +49,9 @@ import {
IConfigurationModify,
IEnvironmentRead,
ILogger,
} from '@rocket.chat/apps-ts-definition/accessors';
import { App } from '@rocket.chat/apps-ts-definition/App';
import { IAppInfo } from '@rocket.chat/apps-ts-definition/metadata';
} from '@rocket.chat/apps-engine/definition/accessors';
import { App } from '@rocket.chat/apps-engine/definition/App';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
export class TodoListApp extends App {
constructor(info: IAppInfo, logger: ILogger) {
......
import { Command, flags } from '@oclif/command';
import { IAppInfo } from '@rocket.chat/apps-ts-definition/metadata';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
import chalk from 'chalk';
import cli from 'cli-ux';
import pascalCase = require('pascal-case');
......
......@@ -32,9 +32,9 @@ export class AppCreator {
const toWrite =
`import {
ILogger,
} from '@rocket.chat/apps-ts-definition/accessors';
import { App } from '@rocket.chat/apps-ts-definition/App';
import { IAppInfo } from '@rocket.chat/apps-ts-definition/metadata';
} from '@rocket.chat/apps-engine/definition/accessors';
import { App } from '@rocket.chat/apps-engine/definition/App';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
export class ${ pascalCase(this.fd.info.name) }App extends App {
constructor(info: IAppInfo, logger: ILogger) {
......@@ -70,8 +70,8 @@ Here are some commands to get started:
## Documentation
Here are some links to examples and documentation:
- [Rocket.Chat Apps TypeScript Definitions Documentation](https://rocketchat.github.io/Rocket.Chat.Apps-ts-definition/)
- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-ts-definition)
- [Rocket.Chat Apps TypeScript Definitions Documentation](https://rocketchat.github.io/Rocket.Chat.Apps-engine/)
- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-engine)
- [Example Rocket.Chat Apps](https://github.com/graywolf336/RocketChatApps)
- Community Forums
- [App Requests](https://forums.rocket.chat/c/rocket-chat-apps/requests)
......@@ -133,7 +133,7 @@ Here are some links to examples and documentation:
const toWrite =
`{
"devDependencies": {
"@rocket.chat/apps-ts-definition": "^0.9.13",
"@rocket.chat/apps-engine": "^0.9.13",
"tslint": "^5.10.0",
"typescript": "^2.9.1"
}
......
import Command from '@oclif/command';
import { IAppInfo } from '@rocket.chat/apps-ts-definition/metadata';
import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
import chalk from 'chalk';
import * as figures from 'figures';
import * as fs from 'fs-extra';
......
......@@ -11,7 +11,7 @@ export class VariousUtils {
};
public static getTsDefVersion = function _getTsDefVersion(): string {
const devLocation = 'node_modules/@rocket.chat/apps-ts-definition/package.json';
const devLocation = 'node_modules/@rocket.chat/apps-engine/package.json';
if (fs.existsSync(devLocation)) {
const info = JSON.parse(fs.readFileSync(devLocation, 'utf8'));
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment