ctipackage

Documentation

Index

• Constants
• func ValidateID(id string) error
• type Asset
• type Dictionaries
• type Dictionary
• type Entity
• type Entry
• type Field
• type Index
  • func DecodeIndex(input io.Reader) (*Index, error)
  • func ReadIndex(dirPath string) (*Index, error)
  • func ReadIndexFile(fPath string) (*Index, error)
  • func (idx *Index) Check() error
  • func (idx *Index) Clone() *Index
  • func (idx *Index) GenerateIndexRaml(includeExamples bool) string
  • func (idx *Index) GetAssets() []string
  • func (idx *Index) GetEntities() ([]Entity, error)
  • func (idx *Index) PutSerialized(fName string)
  • func (idx *Index) Save(baseDir string) error
  • func (idx *Index) ToBytes() []byte
• type IndexLock
  • func ReadIndexLock(pkgDir string) (*IndexLock, error)
  • func (idx *IndexLock) Save(baseDir string) error
• type Info
• type InitializeOption
  • func WithEntities(entities []string) InitializeOption
  • func WithID(id string) InitializeOption
  • func WithRamlxVersion(version string) InitializeOption
• type LangCode
• type Package
  • func New(baseDir string, options ...InitializeOption) (*Package, error)
  • func (pkg *Package) DumpCache() error
  • func (pkg *Package) GetDictionaries() (Dictionaries, error)
  • func (pkg *Package) Initialize() error
  • func (pkg *Package) Parse() error
  • func (pkg *Package) ParseWithCache() (*collector.CtiRegistry, error)
  • func (pkg *Package) Read() error
  • func (pkg *Package) SaveIndex() error
  • func (pkg *Package) SaveIndexLock() error
  • func (pkg *Package) Sync() error
  • func (pkg *Package) Validate() error
  • func (pkg *Package) ValidateRamlxSpec() error
• type SourceInfo

Constants

const (
	IndexFileName = "index.json"
	RAMLExt       = ".raml"
)

const (
	IndexLockFileName = "index-lock.json"
	IndexLockVersion  = "v1"
)

const (
	DependencyDirName = ".dep"
)

const (
	MetadataCacheFile = ".cache.json"
)

const (
	RamlxDirName = ".ramlx"
)

Functions

func ValidateID

func ValidateID(id string) error

Types

type Asset

type Asset struct {
	Name  string `json:"name"`
	Value []byte `json:"value"`
}

type Dictionaries

type Dictionaries struct {
	Dictionaries Dictionary `json:"dictionaries"`
}

type Dictionary

type Dictionary map[LangCode]Entry

type Entity

type Entity struct {
	Name string `json:"name"`
	Path string `json:"path"`
}

type Entry

type Entry map[Field]string

type Field

type Field string

type Index

type Index struct {
	PackageID            string            `json:"package_id"`
	RamlxVersion         string            `json:"ramlx_version"`
	Apis                 []string          `json:"apis,omitempty"`
	Entities             []string          `json:"entities,omitempty"`
	Assets               []string          `json:"assets,omitempty"`
	Dictionaries         []string          `json:"dictionaries,omitempty"`
	Depends              map[string]string `json:"depends,omitempty"`
	Examples             []string          `json:"examples,omitempty"`
	AdditionalProperties interface{}       `json:"additional_properties,omitempty"`
	Serialized           []string          `json:"serialized,omitempty"`
}

func DecodeIndex

func DecodeIndex(input io.Reader) (*Index, error)

func ReadIndex

func ReadIndex(dirPath string) (*Index, error)

func ReadIndexFile

func ReadIndexFile(fPath string) (*Index, error)

func (*Index) Check

func (idx *Index) Check() error

func (*Index) Clone

func (idx *Index) Clone() *Index

func (*Index) GenerateIndexRaml

func (idx *Index) GenerateIndexRaml(includeExamples bool) string

func (*Index) GetAssets

func (idx *Index) GetAssets() []string

func (*Index) GetEntities

func (idx *Index) GetEntities() ([]Entity, error)

func (*Index) PutSerialized

func (idx *Index) PutSerialized(fName string)

func (*Index) Save

func (idx *Index) Save(baseDir string) error

func (*Index) ToBytes

func (idx *Index) ToBytes() []byte

type IndexLock

type IndexLock struct {
	Version string `json:"version"`
	// Reverse map: key - package id, value - source
	DependentPackages map[string]string `json:"depends"`
	// Direct map: key - source, value - Info
	SourceInfo map[string]Info `json:"dependsInfo"`
}

func ReadIndexLock

func ReadIndexLock(pkgDir string) (*IndexLock, error)

func (*IndexLock) Save

func (idx *IndexLock) Save(baseDir string) error

type Info

type Info struct {
	PackageID       string            `json:"package_id"`
	Version         string            `json:"version"`
	Integrity       string            `json:"integrity"`
	Source          string            `json:"source"`
	SourceIntegrity string            `json:"source_integrity"`
	Depends         map[string]string `json:"depends"`
}

type InitializeOption

type InitializeOption func(*Package) error

func WithEntities

func WithEntities(entities []string) InitializeOption

func WithID

func WithID(id string) InitializeOption

func WithRamlxVersion

func WithRamlxVersion(version string) InitializeOption

type LangCode

type LangCode string

type Package

type Package struct {
	Index     *Index
	IndexLock *IndexLock

	Registry *collector.CtiRegistry

	BaseDir string
}

func New

func New(baseDir string, options ...InitializeOption) (*Package, error)

New creates a new package from the specified path. If the path is empty, the current working directory is used.

func (*Package) DumpCache

func (pkg *Package) DumpCache() error

func (*Package) GetDictionaries

func (pkg *Package) GetDictionaries() (Dictionaries, error)

func (*Package) Initialize

func (pkg *Package) Initialize() error

func (*Package) Parse

func (pkg *Package) Parse() error

func (*Package) ParseWithCache

func (pkg *Package) ParseWithCache() (*collector.CtiRegistry, error)

func (*Package) Read

func (pkg *Package) Read() error

func (*Package) SaveIndex

func (pkg *Package) SaveIndex() error

func (*Package) SaveIndexLock

func (pkg *Package) SaveIndexLock() error

func (*Package) Sync

func (pkg *Package) Sync() error

func (*Package) Validate

func (pkg *Package) Validate() error

func (*Package) ValidateRamlxSpec

func (pkg *Package) ValidateRamlxSpec() error

type SourceInfo

type SourceInfo struct {
	Source string `json:"source"`
}